Download OpenAPI specification:Download
The InfluxDB v2 API provides a programmatic interface for all interactions with InfluxDB. Access the InfluxDB API using the /api/v2/ endpoint.
InfluxDB API tokens ensure secure interaction between users and data. A token belongs to an organization and identifies InfluxDB permissions within the organization.
Include your API token in an Authentication: Token YOUR_API_TOKEN HTTP header with each request.
curl https://us-east-1-1.aws.cloud2.influxdata.com/
--header "Authentication: Token YOUR_API_TOKEN"
For more information and examples, see the following:
| Security Scheme Type | HTTP |
|---|---|
| HTTP Authorization Scheme | token |
Use Basic authentication with clients that support the InfluxDB 1.x convention of username and password (that don't support the Authorization: Token scheme):
curl --get "https://europe-west1-1.gcp.cloud2.influxdata.com/query"
--user "YOUR_USERNAME":"YOUR_TOKEN_OR_PASSWORD"
For more information and examples, see how to authenticate with a username and password scheme.
| Security Scheme Type | HTTP |
|---|---|
| HTTP Authorization Scheme | basic |
Use InfluxDB 1.x API parameters to provide credentials through the query string.
Username and password schemes require the following credentials:
curl --get "https://europe-west1-1.gcp.cloud2.influxdata.com/query"
--data-urlencode "u=YOUR_USERNAME"
--data-urlencode "p=YOUR_TOKEN_OR_PASSWORD"
For more information and examples, see how to authenticate with a username and password scheme.
| Security Scheme Type | API Key |
|---|---|
| Query parameter name: | u=&p= |
Use one of the following schemes to authenticate to the InfluxDB API:
InfluxDB API tokens ensure secure interaction between users and data. A token belongs to an organization and identifies InfluxDB permissions within the organization.
Include your API token in an Authentication: Token YOUR_API_TOKEN HTTP header with each request.
curl https://us-east-1-1.aws.cloud2.influxdata.com/
--header "Authentication: Token YOUR_API_TOKEN"
For more information and examples, see the following:
| Security Scheme Type | HTTP |
|---|---|
| HTTP Authorization Scheme | token |
Use Basic authentication with clients that support the InfluxDB 1.x convention of username and password (that don't support the Authorization: Token scheme):
curl --get "https://europe-west1-1.gcp.cloud2.influxdata.com/query"
--user "YOUR_USERNAME":"YOUR_TOKEN_OR_PASSWORD"
For more information and examples, see how to authenticate with a username and password scheme.
| Security Scheme Type | HTTP |
|---|---|
| HTTP Authorization Scheme | basic |
Use InfluxDB 1.x API parameters to provide credentials through the query string.
Username and password schemes require the following credentials:
curl --get "https://europe-west1-1.gcp.cloud2.influxdata.com/query"
--data-urlencode "u=YOUR_USERNAME"
--data-urlencode "p=YOUR_TOKEN_OR_PASSWORD"
For more information and examples, see how to authenticate with a username and password scheme.
| Security Scheme Type | API Key |
|---|---|
| Query parameter name: | u=&p= |
Writes data to a bucket.
To write data into InfluxDB, you need the following:
For more information and examples, see Write data with the InfluxDB API.
| org required | string The parameter value specifies the destination organization for writes. The database writes all points in the batch to this organization. If you provide both |
| orgID | string The parameter value specifies the ID of the destination organization for writes. If both |
| bucket required | string The destination bucket for writes. |
| precision | string (WritePrecision) Enum: "ms" "s" "us" "ns" The precision for the unix timestamps within the body line-protocol. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
| Content-Encoding | string Default: identity Enum: "gzip" "identity" When present, the header value tells the database that compression is applied to the line protocol in the request body. |
| Content-Type | string Default: text/plain; charset=utf-8 Enum: "text/plain" "text/plain; charset=utf-8" "application/vnd.influx.arrow" The header value indicates the format of the data in the request body. |
| Content-Length | integer The header value indicates the size of the entity-body, in bytes, sent to the database. If the length is greater than the database's |
| Accept | string Default: application/json Value: "application/json" The header value specifies the response format. |
Data in line protocol format.
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string",
- "line": 0
}Analyzes flux query and generates a query specification.
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
| Content-Type | string Value: "application/json" |
Analyzed Flux query to generate abstract syntax tree.
| query required | string Flux query script to be analyzed |
{- "query": "string"
}{- "ast": {
- "type": "string",
- "path": "string",
- "package": "string",
- "files": [
- {
- "type": "string",
- "name": "string",
- "package": {
- "type": "string",
- "name": {
- "type": "string",
- "name": "string"
}
}, - "imports": [
- {
- "type": "string",
- "as": {
- "type": "string",
- "name": "string"
}, - "path": {
- "type": "string",
- "value": "string"
}
}
], - "body": [
- {
- "type": "string",
- "text": "string"
}
]
}
]
}
}| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "funcs": [
- {
- "name": "string",
- "params": {
- "property1": "string",
- "property2": "string"
}
}
]
}| name required | string The name of the branching suggestion. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "name": "string",
- "params": {
- "property1": "string",
- "property2": "string"
}
}| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
| Content-Type | string Value: "application/json" |
Flux or InfluxQL query to analyze
object (File) Represents a source from a single file | |
| query required | string Query script to execute. |
| type | string Value: "flux" The type of query. Must be "flux". |
object Enumeration of key-value pairs that respresent parameters to be injected into query (can only specify either this field or extern and not both) | |
object (Dialect) Dialect are options to change the default CSV output format; https://www.w3.org/TR/2015/REC-tabular-metadata-20151217/#dialect-descriptions | |
| now | string <date-time> Specifies the time that should be reported as "now" in the query. Default is the server's now time. |
{- "extern": {
- "type": "string",
- "name": "string",
- "package": {
- "type": "string",
- "name": {
- "type": "string",
- "name": "string"
}
}, - "imports": [
- {
- "type": "string",
- "as": {
- "type": "string",
- "name": "string"
}, - "path": {
- "type": "string",
- "value": "string"
}
}
], - "body": [
- {
- "type": "string",
- "text": "string"
}
]
}, - "query": "string",
- "type": "flux",
- "params": { },
- "dialect": {
- "header": true,
- "delimiter": ",",
- "annotations": [
- "group"
], - "commentPrefix": "#",
- "dateTimeFormat": "RFC3339"
}, - "now": "2019-08-24T14:15:22Z"
}{- "errors": [
- {
- "line": 0,
- "column": 0,
- "character": 0,
- "message": "string"
}
]
}Retrieves data from InfluxDB buckets.
To query data, you need the following:
For more information and examples, see Query with the InfluxDB API.
| org | string Specifies the name of the organization executing the query. Takes either the ID or Name. If both |
| orgID | string Specifies the ID of the organization executing the query. If both |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
| Accept-Encoding | string Default: identity Enum: "gzip" "identity" The Accept-Encoding request HTTP header advertises which content encoding, usually a compression algorithm, the client is able to understand. |
| Content-Type | string Enum: "application/json" "application/vnd.flux" |
Flux query or specification to execute
object (File) Represents a source from a single file | |
| query required | string Query script to execute. |
| type | string Value: "flux" The type of query. Must be "flux". |
object Enumeration of key-value pairs that respresent parameters to be injected into query (can only specify either this field or extern and not both) | |
object (Dialect) Dialect are options to change the default CSV output format; https://www.w3.org/TR/2015/REC-tabular-metadata-20151217/#dialect-descriptions | |
| now | string <date-time> Specifies the time that should be reported as "now" in the query. Default is the server's now time. |
{- "extern": {
- "type": "string",
- "name": "string",
- "package": {
- "type": "string",
- "name": {
- "type": "string",
- "name": "string"
}
}, - "imports": [
- {
- "type": "string",
- "as": {
- "type": "string",
- "name": "string"
}, - "path": {
- "type": "string",
- "value": "string"
}
}
], - "body": [
- {
- "type": "string",
- "text": "string"
}
]
}, - "query": "string",
- "type": "flux",
- "params": { },
- "dialect": {
- "header": true,
- "delimiter": ",",
- "annotations": [
- "group"
], - "commentPrefix": "#",
- "dateTimeFormat": "RFC3339"
}, - "now": "2019-08-24T14:15:22Z"
}{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| offset | integer >= 0 |
| limit | integer [ 1 .. 100 ] Default: 20 |
| after | string The last resource ID from which to seek from (but not including). This is to be used instead of |
| org | string The name of the organization. |
| orgID | string The organization ID. |
| name | string Only returns buckets with a specific name. |
| id | string Only returns buckets with a specific ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "buckets": [
- {
- "links": {
- "labels": "/api/v2/buckets/1/labels",
- "members": "/api/v2/buckets/1/members",
- "org": "/api/v2/orgs/2",
- "owners": "/api/v2/buckets/1/owners",
- "self": "/api/v2/buckets/1",
- "write": "/api/v2/write?org=2&bucket=1"
}, - "id": "string",
- "type": "user",
- "name": "string",
- "description": "string",
- "orgID": "string",
- "rp": "string",
- "schemaType": "implicit",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "retentionRules": [
- {
- "type": "expire",
- "everySeconds": 86400,
- "shardGroupDurationSeconds": 0
}
], - "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
]
}
]
}| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Bucket to create
| orgID required | string |
| name required | string |
| description | string |
| rp | string |
required | Array of objects (RetentionRules) Rules to expire or retain data. No rules means data never expires. |
| schemaType | string (SchemaType) Enum: "implicit" "explicit" |
{- "orgID": "string",
- "name": "string",
- "description": "string",
- "rp": "string",
- "retentionRules": [
- {
- "type": "expire",
- "everySeconds": 86400,
- "shardGroupDurationSeconds": 0
}
], - "schemaType": "implicit"
}{- "links": {
- "labels": "/api/v2/buckets/1/labels",
- "members": "/api/v2/buckets/1/members",
- "org": "/api/v2/orgs/2",
- "owners": "/api/v2/buckets/1/owners",
- "self": "/api/v2/buckets/1",
- "write": "/api/v2/write?org=2&bucket=1"
}, - "id": "string",
- "type": "user",
- "name": "string",
- "description": "string",
- "orgID": "string",
- "rp": "string",
- "schemaType": "implicit",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "retentionRules": [
- {
- "type": "expire",
- "everySeconds": 86400,
- "shardGroupDurationSeconds": 0
}
], - "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
]
}| bucketID required | string The bucket ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "links": {
- "labels": "/api/v2/buckets/1/labels",
- "members": "/api/v2/buckets/1/members",
- "org": "/api/v2/orgs/2",
- "owners": "/api/v2/buckets/1/owners",
- "self": "/api/v2/buckets/1",
- "write": "/api/v2/write?org=2&bucket=1"
}, - "id": "string",
- "type": "user",
- "name": "string",
- "description": "string",
- "orgID": "string",
- "rp": "string",
- "schemaType": "implicit",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "retentionRules": [
- {
- "type": "expire",
- "everySeconds": 86400,
- "shardGroupDurationSeconds": 0
}
], - "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
]
}| bucketID required | string The bucket ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Bucket update to apply
| name | string |
| description | string |
Array of objects (PatchRetentionRules) Updates to rules to expire or retain data. No rules means no updates. |
{- "name": "string",
- "description": "string",
- "retentionRules": [
- {
- "type": "expire",
- "everySeconds": 86400,
- "shardGroupDurationSeconds": 0
}
]
}{- "links": {
- "labels": "/api/v2/buckets/1/labels",
- "members": "/api/v2/buckets/1/members",
- "org": "/api/v2/orgs/2",
- "owners": "/api/v2/buckets/1/owners",
- "self": "/api/v2/buckets/1",
- "write": "/api/v2/write?org=2&bucket=1"
}, - "id": "string",
- "type": "user",
- "name": "string",
- "description": "string",
- "orgID": "string",
- "rp": "string",
- "schemaType": "implicit",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "retentionRules": [
- {
- "type": "expire",
- "everySeconds": 86400,
- "shardGroupDurationSeconds": 0
}
], - "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
]
}| bucketID required | string The ID of the bucket to delete. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| bucketID required | string The bucket ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
],
}| bucketID required | string The bucket ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Label to add
| labelID | string |
{- "labelID": "string"
}{- "label": {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
},
}| bucketID required | string The bucket ID. |
| labelID required | string The ID of the label to delete. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| bucketID required | string The bucket ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "users": [
- {
- "id": "string",
- "oauthID": "string",
- "name": "string",
- "status": "active",
- "links": {
- "self": "/api/v2/users/1"
}, - "role": "member"
}
]
}| bucketID required | string The bucket ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
User to add as member
| id required | string |
| name | string |
{- "id": "string",
- "name": "string"
}{- "id": "string",
- "oauthID": "string",
- "name": "string",
- "status": "active",
- "links": {
- "self": "/api/v2/users/1"
}, - "role": "member"
}| userID required | string The ID of the member to remove. |
| bucketID required | string The bucket ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| bucketID required | string The bucket ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "users": [
- {
- "id": "string",
- "oauthID": "string",
- "name": "string",
- "status": "active",
- "links": {
- "self": "/api/v2/users/1"
}, - "role": "owner"
}
]
}| bucketID required | string The bucket ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
User to add as owner
| id required | string |
| name | string |
{- "id": "string",
- "name": "string"
}{- "id": "string",
- "oauthID": "string",
- "name": "string",
- "status": "active",
- "links": {
- "self": "/api/v2/users/1"
}, - "role": "owner"
}| userID required | string The ID of the owner to remove. |
| bucketID required | string The bucket ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| dashboardID required | string The ID of the dashboard to update. |
| include | string Value: "properties" Includes the cell view properties in the response if set to |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "orgID": "string",
- "name": "string",
- "description": "string",
- "links": {
- "self": "/api/v2/dashboards/1",
- "cells": "/api/v2/dashboards/1/cells",
- "owners": "/api/v2/dashboards/1/owners",
- "members": "/api/v2/dashboards/1/members",
- "labels": "/api/v2/dashboards/1/labels",
- "org": "/api/v2/labels/1"
}, - "id": "string",
- "meta": {
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}, - "cells": [
- {
- "id": "string",
- "links": {
- "self": "string",
- "view": "string"
}, - "x": 0,
- "y": 0,
- "w": 0,
- "h": 0,
- "viewID": "string"
}
], - "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
]
}| dashboardID required | string The ID of the dashboard to update. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Patching of a dashboard
| name | string optional, when provided will replace the name |
| description | string optional, when provided will replace the description |
object (CellWithViewProperties) |
{- "name": "string",
- "description": "string",
- "cells": {
- "id": "string",
- "links": {
- "self": "string",
- "view": "string"
}, - "x": 0,
- "y": 0,
- "w": 0,
- "h": 0,
- "viewID": "string",
- "name": "string",
- "properties": {
- "timeFormat": "string",
- "type": "line-plus-single-stat",
- "queries": [
- {
- "text": "string",
- "editMode": "builder",
- "name": "string",
- "builderConfig": {
- "buckets": [
- "string"
], - "tags": [
- {
- "key": "string",
- "values": [
- "string"
], - "aggregateFunctionType": "filter"
}
], - "functions": [
- {
- "name": "string"
}
], - "aggregateWindow": {
- "period": "string",
- "fillValues": true
}
}
}
], - "colors": [
- {
- "id": "string",
- "type": "min",
- "hex": "strings",
- "name": "string",
- "value": 0
}
], - "shape": "chronograf-v2",
- "note": "string",
- "showNoteWhenEmpty": true,
- "axes": {
- "x": {
- "bounds": [
- "string"
], - "label": "string",
- "prefix": "string",
- "suffix": "string",
- "base": "",
- "scale": "log"
}, - "y": {
- "bounds": [
- "string"
], - "label": "string",
- "prefix": "string",
- "suffix": "string",
- "base": "",
- "scale": "log"
}
}, - "staticLegend": {
- "colorizeRows": true,
- "heightRatio": 0,
- "show": true,
- "opacity": 0,
- "orientationThreshold": 0,
- "valueAxis": "string",
- "widthRatio": 0
}, - "xColumn": "string",
- "generateXAxisTicks": [
- "string"
], - "xTotalTicks": 0,
- "xTickStart": 0,
- "xTickStep": 0,
- "yColumn": "string",
- "generateYAxisTicks": [
- "string"
], - "yTotalTicks": 0,
- "yTickStart": 0,
- "yTickStep": 0,
- "shadeBelow": true,
- "hoverDimension": "auto",
- "position": "overlaid",
- "prefix": "string",
- "suffix": "string",
- "decimalPlaces": {
- "isEnforced": true,
- "digits": 0
}, - "legendColorizeRows": true,
- "legendHide": true,
- "legendOpacity": 0,
- "legendOrientationThreshold": 0
}
}
}{- "orgID": "string",
- "name": "string",
- "description": "string",
- "links": {
- "self": "/api/v2/dashboards/1",
- "cells": "/api/v2/dashboards/1/cells",
- "owners": "/api/v2/dashboards/1/owners",
- "members": "/api/v2/dashboards/1/members",
- "labels": "/api/v2/dashboards/1/labels",
- "org": "/api/v2/labels/1"
}, - "id": "string",
- "meta": {
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}, - "cells": [
- {
- "id": "string",
- "links": {
- "self": "string",
- "view": "string"
}, - "x": 0,
- "y": 0,
- "w": 0,
- "h": 0,
- "viewID": "string"
}
], - "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
]
}| dashboardID required | string The ID of the dashboard to update. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}Replaces all cells in a dashboard. This is used primarily to update the positional information of all cells.
| dashboardID required | string The ID of the dashboard to update. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
| id | string |
object | |
| x | integer <int32> |
| y | integer <int32> |
| w | integer <int32> |
| h | integer <int32> |
| viewID | string The reference to a view from the views API. |
[- {
- "id": "string",
- "links": {
- "self": "string",
- "view": "string"
}, - "x": 0,
- "y": 0,
- "w": 0,
- "h": 0,
- "viewID": "string"
}
]{- "orgID": "string",
- "name": "string",
- "description": "string",
- "links": {
- "self": "/api/v2/dashboards/1",
- "cells": "/api/v2/dashboards/1/cells",
- "owners": "/api/v2/dashboards/1/owners",
- "members": "/api/v2/dashboards/1/members",
- "labels": "/api/v2/dashboards/1/labels",
- "org": "/api/v2/labels/1"
}, - "id": "string",
- "meta": {
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}, - "cells": [
- {
- "id": "string",
- "links": {
- "self": "string",
- "view": "string"
}, - "x": 0,
- "y": 0,
- "w": 0,
- "h": 0,
- "viewID": "string"
}
], - "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
]
}| dashboardID required | string The ID of the dashboard to update. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Cell that will be added
| name | string |
| x | integer <int32> |
| y | integer <int32> |
| w | integer <int32> |
| h | integer <int32> |
| usingView | string Makes a copy of the provided view. |
{- "name": "string",
- "x": 0,
- "y": 0,
- "w": 0,
- "h": 0,
- "usingView": "string"
}{- "id": "string",
- "links": {
- "self": "string",
- "view": "string"
}, - "x": 0,
- "y": 0,
- "w": 0,
- "h": 0,
- "viewID": "string"
}Updates the non positional information related to a cell. Updates to a single cell's positional data could cause grid conflicts.
| dashboardID required | string The ID of the dashboard to update. |
| cellID required | string The ID of the cell to update. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
| x | integer <int32> |
| y | integer <int32> |
| w | integer <int32> |
| h | integer <int32> |
{- "x": 0,
- "y": 0,
- "w": 0,
- "h": 0
}{- "id": "string",
- "links": {
- "self": "string",
- "view": "string"
}, - "x": 0,
- "y": 0,
- "w": 0,
- "h": 0,
- "viewID": "string"
}| dashboardID required | string The ID of the dashboard to delete. |
| cellID required | string The ID of the cell to delete. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| dashboardID required | string The dashboard ID. |
| cellID required | string The cell ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "links": {
- "self": "string"
}, - "id": "string",
- "name": "string",
- "properties": {
- "timeFormat": "string",
- "type": "line-plus-single-stat",
- "queries": [
- {
- "text": "string",
- "editMode": "builder",
- "name": "string",
- "builderConfig": {
- "buckets": [
- "string"
], - "tags": [
- {
- "key": "string",
- "values": [
- "string"
], - "aggregateFunctionType": "filter"
}
], - "functions": [
- {
- "name": "string"
}
], - "aggregateWindow": {
- "period": "string",
- "fillValues": true
}
}
}
], - "colors": [
- {
- "id": "string",
- "type": "min",
- "hex": "strings",
- "name": "string",
- "value": 0
}
], - "shape": "chronograf-v2",
- "note": "string",
- "showNoteWhenEmpty": true,
- "axes": {
- "x": {
- "bounds": [
- "string"
], - "label": "string",
- "prefix": "string",
- "suffix": "string",
- "base": "",
- "scale": "log"
}, - "y": {
- "bounds": [
- "string"
], - "label": "string",
- "prefix": "string",
- "suffix": "string",
- "base": "",
- "scale": "log"
}
}, - "staticLegend": {
- "colorizeRows": true,
- "heightRatio": 0,
- "show": true,
- "opacity": 0,
- "orientationThreshold": 0,
- "valueAxis": "string",
- "widthRatio": 0
}, - "xColumn": "string",
- "generateXAxisTicks": [
- "string"
], - "xTotalTicks": 0,
- "xTickStart": 0,
- "xTickStep": 0,
- "yColumn": "string",
- "generateYAxisTicks": [
- "string"
], - "yTotalTicks": 0,
- "yTickStart": 0,
- "yTickStep": 0,
- "shadeBelow": true,
- "hoverDimension": "auto",
- "position": "overlaid",
- "prefix": "string",
- "suffix": "string",
- "decimalPlaces": {
- "isEnforced": true,
- "digits": 0
}, - "legendColorizeRows": true,
- "legendHide": true,
- "legendOpacity": 0,
- "legendOrientationThreshold": 0
}
}| dashboardID required | string The ID of the dashboard to update. |
| cellID required | string The ID of the cell to update. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
| name required | string |
required | LinePlusSingleStatProperties (object) or XYViewProperties (object) or SingleStatViewProperties (object) or HistogramViewProperties (object) or GaugeViewProperties (object) or TableViewProperties (object) or SimpleTableViewProperties (object) or MarkdownViewProperties (object) or CheckViewProperties (object) or ScatterViewProperties (object) or HeatmapViewProperties (object) or MosaicViewProperties (object) or BandViewProperties (object) or GeoViewProperties (object) (ViewProperties) |
{- "name": "string",
- "properties": {
- "timeFormat": "string",
- "type": "line-plus-single-stat",
- "queries": [
- {
- "text": "string",
- "editMode": "builder",
- "name": "string",
- "builderConfig": {
- "buckets": [
- "string"
], - "tags": [
- {
- "key": "string",
- "values": [
- "string"
], - "aggregateFunctionType": "filter"
}
], - "functions": [
- {
- "name": "string"
}
], - "aggregateWindow": {
- "period": "string",
- "fillValues": true
}
}
}
], - "colors": [
- {
- "id": "string",
- "type": "min",
- "hex": "strings",
- "name": "string",
- "value": 0
}
], - "shape": "chronograf-v2",
- "note": "string",
- "showNoteWhenEmpty": true,
- "axes": {
- "x": {
- "bounds": [
- "string"
], - "label": "string",
- "prefix": "string",
- "suffix": "string",
- "base": "",
- "scale": "log"
}, - "y": {
- "bounds": [
- "string"
], - "label": "string",
- "prefix": "string",
- "suffix": "string",
- "base": "",
- "scale": "log"
}
}, - "staticLegend": {
- "colorizeRows": true,
- "heightRatio": 0,
- "show": true,
- "opacity": 0,
- "orientationThreshold": 0,
- "valueAxis": "string",
- "widthRatio": 0
}, - "xColumn": "string",
- "generateXAxisTicks": [
- "string"
], - "xTotalTicks": 0,
- "xTickStart": 0,
- "xTickStep": 0,
- "yColumn": "string",
- "generateYAxisTicks": [
- "string"
], - "yTotalTicks": 0,
- "yTickStart": 0,
- "yTickStep": 0,
- "shadeBelow": true,
- "hoverDimension": "auto",
- "position": "overlaid",
- "prefix": "string",
- "suffix": "string",
- "decimalPlaces": {
- "isEnforced": true,
- "digits": 0
}, - "legendColorizeRows": true,
- "legendHide": true,
- "legendOpacity": 0,
- "legendOrientationThreshold": 0
}
}{- "links": {
- "self": "string"
}, - "id": "string",
- "name": "string",
- "properties": {
- "timeFormat": "string",
- "type": "line-plus-single-stat",
- "queries": [
- {
- "text": "string",
- "editMode": "builder",
- "name": "string",
- "builderConfig": {
- "buckets": [
- "string"
], - "tags": [
- {
- "key": "string",
- "values": [
- "string"
], - "aggregateFunctionType": "filter"
}
], - "functions": [
- {
- "name": "string"
}
], - "aggregateWindow": {
- "period": "string",
- "fillValues": true
}
}
}
], - "colors": [
- {
- "id": "string",
- "type": "min",
- "hex": "strings",
- "name": "string",
- "value": 0
}
], - "shape": "chronograf-v2",
- "note": "string",
- "showNoteWhenEmpty": true,
- "axes": {
- "x": {
- "bounds": [
- "string"
], - "label": "string",
- "prefix": "string",
- "suffix": "string",
- "base": "",
- "scale": "log"
}, - "y": {
- "bounds": [
- "string"
], - "label": "string",
- "prefix": "string",
- "suffix": "string",
- "base": "",
- "scale": "log"
}
}, - "staticLegend": {
- "colorizeRows": true,
- "heightRatio": 0,
- "show": true,
- "opacity": 0,
- "orientationThreshold": 0,
- "valueAxis": "string",
- "widthRatio": 0
}, - "xColumn": "string",
- "generateXAxisTicks": [
- "string"
], - "xTotalTicks": 0,
- "xTickStart": 0,
- "xTickStep": 0,
- "yColumn": "string",
- "generateYAxisTicks": [
- "string"
], - "yTotalTicks": 0,
- "yTickStart": 0,
- "yTickStep": 0,
- "shadeBelow": true,
- "hoverDimension": "auto",
- "position": "overlaid",
- "prefix": "string",
- "suffix": "string",
- "decimalPlaces": {
- "isEnforced": true,
- "digits": 0
}, - "legendColorizeRows": true,
- "legendHide": true,
- "legendOpacity": 0,
- "legendOrientationThreshold": 0
}
}| dashboardID required | string The dashboard ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
],
}| dashboardID required | string The dashboard ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Label to add
| labelID | string |
{- "labelID": "string"
}{- "label": {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
},
}| dashboardID required | string The dashboard ID. |
| labelID required | string The ID of the label to delete. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| dashboardID required | string The dashboard ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "users": [
- {
- "id": "string",
- "oauthID": "string",
- "name": "string",
- "status": "active",
- "links": {
- "self": "/api/v2/users/1"
}, - "role": "member"
}
]
}| dashboardID required | string The dashboard ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
User to add as member
| id required | string |
| name | string |
{- "id": "string",
- "name": "string"
}{- "id": "string",
- "oauthID": "string",
- "name": "string",
- "status": "active",
- "links": {
- "self": "/api/v2/users/1"
}, - "role": "member"
}| userID required | string The ID of the member to remove. |
| dashboardID required | string The dashboard ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| dashboardID required | string The dashboard ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "users": [
- {
- "id": "string",
- "oauthID": "string",
- "name": "string",
- "status": "active",
- "links": {
- "self": "/api/v2/users/1"
}, - "role": "owner"
}
]
}| dashboardID required | string The dashboard ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
User to add as owner
| id required | string |
| name | string |
{- "id": "string",
- "name": "string"
}{- "id": "string",
- "oauthID": "string",
- "name": "string",
- "status": "active",
- "links": {
- "self": "/api/v2/users/1"
}, - "role": "owner"
}| userID required | string The ID of the owner to remove. |
| dashboardID required | string The dashboard ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Dashboard to create
| orgID required | string The ID of the organization that owns the dashboard. |
| name required | string The user-facing name of the dashboard. |
| description | string The user-facing description of the dashboard. |
{- "orgID": "string",
- "name": "string",
- "description": "string"
}{- "orgID": "string",
- "name": "string",
- "description": "string",
- "links": {
- "self": "/api/v2/dashboards/1",
- "cells": "/api/v2/dashboards/1/cells",
- "owners": "/api/v2/dashboards/1/owners",
- "members": "/api/v2/dashboards/1/members",
- "labels": "/api/v2/dashboards/1/labels",
- "org": "/api/v2/labels/1"
}, - "id": "string",
- "meta": {
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}, - "cells": [
- {
- "id": "string",
- "links": {
- "self": "string",
- "view": "string"
}, - "x": 0,
- "y": 0,
- "w": 0,
- "h": 0,
- "viewID": "string"
}
], - "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
]
}| offset | integer >= 0 |
| descending | boolean Default: false |
| limit | integer [ -1 .. 100 ] Default: 20 The non-zero number of dashboards to return |
| owner | string A user identifier. Returns only dashboards where this user has the |
| sortBy | string Enum: "ID" "CreatedAt" "UpdatedAt" The column to sort by. |
| id | Array of strings A list of dashboard identifiers. Returns only the listed dashboards. If both |
| orgID | string The identifier of the organization. |
| org | string The name of the organization. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "dashboards": [
- {
- "orgID": "string",
- "name": "string",
- "description": "string",
- "links": {
- "self": "/api/v2/dashboards/1",
- "cells": "/api/v2/dashboards/1/cells",
- "owners": "/api/v2/dashboards/1/owners",
- "members": "/api/v2/dashboards/1/members",
- "labels": "/api/v2/dashboards/1/labels",
- "org": "/api/v2/labels/1"
}, - "id": "string",
- "meta": {
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}, - "cells": [
- {
- "id": "string",
- "links": {
- "self": "string",
- "view": "string"
}, - "x": 0,
- "y": 0,
- "w": 0,
- "h": 0,
- "viewID": "string"
}
], - "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
]
}
]
}| taskID required | string The task ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "id": "string",
- "type": "string",
- "orgID": "string",
- "org": "string",
- "name": "string",
- "ownerID": "string",
- "description": "string",
- "status": "active",
- "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
], - "authorizationID": "string",
- "flux": "string",
- "every": "string",
- "cron": "string",
- "offset": "string",
- "latestCompleted": "2019-08-24T14:15:22Z",
- "lastRunStatus": "failed",
- "lastRunError": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "links": {
- "self": "/api/v2/tasks/1",
- "owners": "/api/v2/tasks/1/owners",
- "members": "/api/v2/tasks/1/members",
- "labels": "/api/v2/tasks/1/labels",
- "runs": "/api/v2/tasks/1/runs",
- "logs": "/api/v2/tasks/1/logs"
}
}Update a task. This will cancel all queued runs.
| taskID required | string The task ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Task update to apply
| status | string (TaskStatusType) Enum: "active" "inactive" |
| flux | string The Flux script to run for this task. |
| name | string Override the 'name' option in the flux script. |
| every | string Override the 'every' option in the flux script. |
| cron | string Override the 'cron' option in the flux script. |
| offset | string Override the 'offset' option in the flux script. |
| description | string An optional description of the task. |
{- "status": "active",
- "flux": "string",
- "name": "string",
- "every": "string",
- "cron": "string",
- "offset": "string",
- "description": "string"
}{- "id": "string",
- "type": "string",
- "orgID": "string",
- "org": "string",
- "name": "string",
- "ownerID": "string",
- "description": "string",
- "status": "active",
- "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
], - "authorizationID": "string",
- "flux": "string",
- "every": "string",
- "cron": "string",
- "offset": "string",
- "latestCompleted": "2019-08-24T14:15:22Z",
- "lastRunStatus": "failed",
- "lastRunError": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "links": {
- "self": "/api/v2/tasks/1",
- "owners": "/api/v2/tasks/1/owners",
- "members": "/api/v2/tasks/1/members",
- "labels": "/api/v2/tasks/1/labels",
- "runs": "/api/v2/tasks/1/runs",
- "logs": "/api/v2/tasks/1/logs"
}
}Deletes a task and all associated records
| taskID required | string The ID of the task to delete. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| taskID required | string The ID of the task to get runs for. |
| after | string Returns runs after a specific ID. |
| limit | integer [ 1 .. 500 ] Default: 100 The number of runs to return |
| afterTime | string <date-time> Filter runs to those scheduled after this time, RFC3339 |
| beforeTime | string <date-time> Filter runs to those scheduled before this time, RFC3339 |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "runs": [
- {
- "id": "string",
- "taskID": "string",
- "status": "scheduled",
- "scheduledFor": "2019-08-24T14:15:22Z",
- "log": [
- {
- "time": "2019-08-24T14:15:22Z",
- "message": "Halt and catch fire",
- "runID": "string"
}
], - "startedAt": "2019-08-24T14:15:22Z",
- "finishedAt": "2019-08-24T14:15:22Z",
- "requestedAt": "2019-08-24T14:15:22Z",
- "links": {
- "self": "/api/v2/tasks/1/runs/1",
- "task": "/api/v2/tasks/1",
- "retry": "/api/v2/tasks/1/runs/1/retry"
}
}
]
}| taskID required | string |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
| scheduledFor | string <date-time> Nullable Time used for run's "now" option, RFC3339. Default is the server's now time. |
{- "scheduledFor": "2019-08-24T14:15:22Z"
}{- "id": "string",
- "taskID": "string",
- "status": "scheduled",
- "scheduledFor": "2019-08-24T14:15:22Z",
- "log": [
- {
- "time": "2019-08-24T14:15:22Z",
- "message": "Halt and catch fire",
- "runID": "string"
}
], - "startedAt": "2019-08-24T14:15:22Z",
- "finishedAt": "2019-08-24T14:15:22Z",
- "requestedAt": "2019-08-24T14:15:22Z",
- "links": {
- "self": "/api/v2/tasks/1/runs/1",
- "task": "/api/v2/tasks/1",
- "retry": "/api/v2/tasks/1/runs/1/retry"
}
}| taskID required | string The task ID. |
| runID required | string The run ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "id": "string",
- "taskID": "string",
- "status": "scheduled",
- "scheduledFor": "2019-08-24T14:15:22Z",
- "log": [
- {
- "time": "2019-08-24T14:15:22Z",
- "message": "Halt and catch fire",
- "runID": "string"
}
], - "startedAt": "2019-08-24T14:15:22Z",
- "finishedAt": "2019-08-24T14:15:22Z",
- "requestedAt": "2019-08-24T14:15:22Z",
- "links": {
- "self": "/api/v2/tasks/1/runs/1",
- "task": "/api/v2/tasks/1",
- "retry": "/api/v2/tasks/1/runs/1/retry"
}
}| taskID required | string The task ID. |
| runID required | string The run ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| taskID required | string The task ID. |
| runID required | string The run ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{ }{- "id": "string",
- "taskID": "string",
- "status": "scheduled",
- "scheduledFor": "2019-08-24T14:15:22Z",
- "log": [
- {
- "time": "2019-08-24T14:15:22Z",
- "message": "Halt and catch fire",
- "runID": "string"
}
], - "startedAt": "2019-08-24T14:15:22Z",
- "finishedAt": "2019-08-24T14:15:22Z",
- "requestedAt": "2019-08-24T14:15:22Z",
- "links": {
- "self": "/api/v2/tasks/1/runs/1",
- "task": "/api/v2/tasks/1",
- "retry": "/api/v2/tasks/1/runs/1/retry"
}
}| taskID required | string The task ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "events": [
- {
- "time": "2019-08-24T14:15:22Z",
- "message": "Halt and catch fire",
- "runID": "string"
}
]
}| taskID required | string ID of task to get logs for. |
| runID required | string ID of run to get logs for. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "events": [
- {
- "time": "2019-08-24T14:15:22Z",
- "message": "Halt and catch fire",
- "runID": "string"
}
]
}| taskID required | string The task ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
],
}| taskID required | string The task ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Label to add
| labelID | string |
{- "labelID": "string"
}{- "label": {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
},
}| taskID required | string The task ID. |
| labelID required | string The label ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| taskID required | string The task ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "users": [
- {
- "id": "string",
- "oauthID": "string",
- "name": "string",
- "status": "active",
- "links": {
- "self": "/api/v2/users/1"
}, - "role": "member"
}
]
}| taskID required | string The task ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
User to add as member
| id required | string |
| name | string |
{- "id": "string",
- "name": "string"
}{- "id": "string",
- "oauthID": "string",
- "name": "string",
- "status": "active",
- "links": {
- "self": "/api/v2/users/1"
}, - "role": "member"
}| userID required | string The ID of the member to remove. |
| taskID required | string The task ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| taskID required | string The task ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "users": [
- {
- "id": "string",
- "oauthID": "string",
- "name": "string",
- "status": "active",
- "links": {
- "self": "/api/v2/users/1"
}, - "role": "owner"
}
]
}| taskID required | string The task ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
User to add as owner
| id required | string |
| name | string |
{- "id": "string",
- "name": "string"
}{- "id": "string",
- "oauthID": "string",
- "name": "string",
- "status": "active",
- "links": {
- "self": "/api/v2/users/1"
}, - "role": "owner"
}| userID required | string The ID of the owner to remove. |
| taskID required | string The task ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| name | string Returns task with a specific name. |
| after | string Return tasks after a specified ID. |
| user | string Filter tasks to a specific user ID. |
| org | string Filter tasks to a specific organization name. |
| orgID | string Filter tasks to a specific organization ID. |
| status | string Enum: "active" "inactive" Filter tasks by a status--"inactive" or "active". |
| limit | integer [ -1 .. 500 ] Default: 100 The non-zero number of tasks to return |
| type | string Default: "" Enum: "basic" "system" Type of task, unset by default. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "tasks": [
- {
- "id": "string",
- "type": "string",
- "orgID": "string",
- "org": "string",
- "name": "string",
- "ownerID": "string",
- "description": "string",
- "status": "active",
- "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
], - "authorizationID": "string",
- "flux": "string",
- "every": "string",
- "cron": "string",
- "offset": "string",
- "latestCompleted": "2019-08-24T14:15:22Z",
- "lastRunStatus": "failed",
- "lastRunError": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "links": {
- "self": "/api/v2/tasks/1",
- "owners": "/api/v2/tasks/1/owners",
- "members": "/api/v2/tasks/1/members",
- "labels": "/api/v2/tasks/1/labels",
- "runs": "/api/v2/tasks/1/runs",
- "logs": "/api/v2/tasks/1/logs"
}
}
]
}| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Task to create
| orgID | string The ID of the organization that owns this Task. |
| org | string The name of the organization that owns this Task. |
| status | string (TaskStatusType) Enum: "active" "inactive" |
| flux required | string The Flux script to run for this task. |
| description | string An optional description of the task. |
{- "orgID": "string",
- "org": "string",
- "status": "active",
- "flux": "string",
- "description": "string"
}{- "id": "string",
- "type": "string",
- "orgID": "string",
- "org": "string",
- "name": "string",
- "ownerID": "string",
- "description": "string",
- "status": "active",
- "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
], - "authorizationID": "string",
- "flux": "string",
- "every": "string",
- "cron": "string",
- "offset": "string",
- "latestCompleted": "2019-08-24T14:15:22Z",
- "lastRunStatus": "failed",
- "lastRunError": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "links": {
- "self": "/api/v2/tasks/1",
- "owners": "/api/v2/tasks/1/owners",
- "members": "/api/v2/tasks/1/members",
- "labels": "/api/v2/tasks/1/labels",
- "runs": "/api/v2/tasks/1/runs",
- "logs": "/api/v2/tasks/1/logs"
}
}Create and manage API tokens. An authorization associates a list of permissions to an organization and provides a token for API access. To assign a token to a specific user, scope the authorization to the user ID.
| userID | string Only show authorizations that belong to a user ID. |
| user | string Only show authorizations that belong to a user name. |
| orgID | string Only show authorizations that belong to an organization ID. |
| org | string Only show authorizations that belong to a organization name. |
| token | string Find a token by value. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "authorizations": [
- {
- "status": "active",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "orgID": "string",
- "permissions": [
- {
- "action": "read",
- "resource": {
- "type": "authorizations",
- "id": "string",
- "name": "string",
- "orgID": "string",
- "org": "string"
}
}
], - "id": "string",
- "token": "string",
- "userID": "string",
- "user": "string",
- "org": "string",
- "links": {
- "self": "/api/v2/authorizations/1",
- "user": "/api/v2/users/12"
}
}
]
}| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Authorization to create
| status | string Default: "active" Enum: "active" "inactive" If inactive the token is inactive and requests using the token will be rejected. |
| description | string A description of the token. |
| orgID required | string ID of org that authorization is scoped to. |
required | Array of objects (Permission) non-empty List of permissions for an auth. An auth must have at least one Permission. |
{- "status": "active",
- "description": "string",
- "orgID": "string",
- "permissions": [
- {
- "action": "read",
- "resource": {
- "type": "authorizations",
- "id": "string",
- "name": "string",
- "orgID": "string",
- "org": "string"
}
}
]
}{- "status": "active",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "orgID": "string",
- "permissions": [
- {
- "action": "read",
- "resource": {
- "type": "authorizations",
- "id": "string",
- "name": "string",
- "orgID": "string",
- "org": "string"
}
}
], - "id": "string",
- "token": "string",
- "userID": "string",
- "user": "string",
- "org": "string",
- "links": {
- "self": "/api/v2/authorizations/1",
- "user": "/api/v2/users/12"
}
}| authID required | string The identifier of the authorization to get. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "status": "active",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "orgID": "string",
- "permissions": [
- {
- "action": "read",
- "resource": {
- "type": "authorizations",
- "id": "string",
- "name": "string",
- "orgID": "string",
- "org": "string"
}
}
], - "id": "string",
- "token": "string",
- "userID": "string",
- "user": "string",
- "org": "string",
- "links": {
- "self": "/api/v2/authorizations/1",
- "user": "/api/v2/users/12"
}
}Update an authorization's status to active or inactive.
| authID required | string The identifier of the authorization to update. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
The updated Authorization object.
| status | string Default: "active" Enum: "active" "inactive" If inactive the token is inactive and requests using the token will be rejected. |
| description | string A description of the token. |
{- "status": "active",
- "description": "string"
}{- "status": "active",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "orgID": "string",
- "permissions": [
- {
- "action": "read",
- "resource": {
- "type": "authorizations",
- "id": "string",
- "name": "string",
- "orgID": "string",
- "org": "string"
}
}
], - "id": "string",
- "token": "string",
- "userID": "string",
- "user": "string",
- "org": "string",
- "links": {
- "self": "/api/v2/authorizations/1",
- "user": "/api/v2/users/12"
}
}| authID required | string The identifier of the authorization to delete. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| offset | integer >= 0 |
| limit | integer [ 1 .. 100 ] Default: 20 |
| descending | boolean Default: false |
| org | string Filter organizations to a specific organization name. |
| orgID | string Filter organizations to a specific organization ID. |
| userID | string Filter organizations to a specific user ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "orgs": [
- {
- "links": {
- "self": "/api/v2/orgs/1",
- "members": "/api/v2/orgs/1/members",
- "owners": "/api/v2/orgs/1/owners",
- "labels": "/api/v2/orgs/1/labels",
- "secrets": "/api/v2/orgs/1/secrets",
- "buckets": "/api/v2/buckets?org=myorg",
- "tasks": "/api/v2/tasks?org=myorg",
- "dashboards": "/api/v2/dashboards?org=myorg"
}, - "id": "string",
- "name": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "status": "active"
}
]
}| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Organization to create
| name required | string |
| description | string |
{- "name": "string",
- "description": "string"
}{- "links": {
- "self": "/api/v2/orgs/1",
- "members": "/api/v2/orgs/1/members",
- "owners": "/api/v2/orgs/1/owners",
- "labels": "/api/v2/orgs/1/labels",
- "secrets": "/api/v2/orgs/1/secrets",
- "buckets": "/api/v2/buckets?org=myorg",
- "tasks": "/api/v2/tasks?org=myorg",
- "dashboards": "/api/v2/dashboards?org=myorg"
}, - "id": "string",
- "name": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "status": "active"
}| orgID required | string The ID of the organization to get. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "links": {
- "self": "/api/v2/orgs/1",
- "members": "/api/v2/orgs/1/members",
- "owners": "/api/v2/orgs/1/owners",
- "labels": "/api/v2/orgs/1/labels",
- "secrets": "/api/v2/orgs/1/secrets",
- "buckets": "/api/v2/buckets?org=myorg",
- "tasks": "/api/v2/tasks?org=myorg",
- "dashboards": "/api/v2/dashboards?org=myorg"
}, - "id": "string",
- "name": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "status": "active"
}| orgID required | string The ID of the organization to get. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Organization update to apply
| name | string New name to set on the organization |
| description | string New description to set on the organization |
{- "name": "string",
- "description": "string"
}{- "links": {
- "self": "/api/v2/orgs/1",
- "members": "/api/v2/orgs/1/members",
- "owners": "/api/v2/orgs/1/owners",
- "labels": "/api/v2/orgs/1/labels",
- "secrets": "/api/v2/orgs/1/secrets",
- "buckets": "/api/v2/buckets?org=myorg",
- "tasks": "/api/v2/tasks?org=myorg",
- "dashboards": "/api/v2/dashboards?org=myorg"
}, - "id": "string",
- "name": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "status": "active"
}| orgID required | string The ID of the organization to delete. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| orgID required | string The organization ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "users": [
- {
- "id": "string",
- "oauthID": "string",
- "name": "string",
- "status": "active",
- "links": {
- "self": "/api/v2/users/1"
}, - "role": "member"
}
]
}| orgID required | string The organization ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
User to add as member
| id required | string |
| name | string |
{- "id": "string",
- "name": "string"
}{- "id": "string",
- "oauthID": "string",
- "name": "string",
- "status": "active",
- "links": {
- "self": "/api/v2/users/1"
}, - "role": "member"
}| userID required | string The ID of the member to remove. |
| orgID required | string The organization ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| orgID required | string The organization ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "users": [
- {
- "id": "string",
- "oauthID": "string",
- "name": "string",
- "status": "active",
- "links": {
- "self": "/api/v2/users/1"
}, - "role": "owner"
}
]
}| orgID required | string The organization ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
User to add as owner
| id required | string |
| name | string |
{- "id": "string",
- "name": "string"
}{- "id": "string",
- "oauthID": "string",
- "name": "string",
- "status": "active",
- "links": {
- "self": "/api/v2/users/1"
}, - "role": "owner"
}| userID required | string The ID of the owner to remove. |
| orgID required | string The organization ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "id": "string",
- "oauthID": "string",
- "name": "string",
- "status": "active",
- "links": {
- "self": "/api/v2/users/1"
}
}| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
New password
| password required | string |
{- "password": "string"
}{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| userID required | string The user ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
New password
| password required | string |
{- "password": "string"
}{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "users": [
- {
- "id": "string",
- "oauthID": "string",
- "name": "string",
- "status": "active",
- "links": {
- "self": "/api/v2/users/1"
}
}
]
}| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
User to create
| oauthID | string |
| name required | string |
| status | string Default: "active" Enum: "active" "inactive" If inactive the user is inactive. |
| role | string Enum: "owner" "member" |
| org_id | string |
{- "oauthID": "string",
- "name": "string",
- "status": "active",
- "role": "owner",
- "org_id": "string"
}{- "id": "string",
- "oauthID": "string",
- "name": "string",
- "status": "active",
- "links": {
- "self": "/api/v2/users/1"
}
}| userID required | string The user ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "id": "string",
- "oauthID": "string",
- "name": "string",
- "status": "active",
- "links": {
- "self": "/api/v2/users/1"
}
}| userID required | string The ID of the user to update. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
User update to apply
| oauthID | string |
| name required | string |
| status | string Default: "active" Enum: "active" "inactive" If inactive the user is inactive. |
| role | string Enum: "owner" "member" |
| org_id | string |
{- "oauthID": "string",
- "name": "string",
- "status": "active",
- "role": "owner",
- "org_id": "string"
}{- "id": "string",
- "oauthID": "string",
- "name": "string",
- "status": "active",
- "links": {
- "self": "/api/v2/users/1"
}
}| userID required | string The ID of the user to delete. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}Create and manage API tokens. An authorization associates a list of permissions to an organization and provides a token for API access. To assign a token to a specific user, scope the authorization to the user ID.
| userID | string Only show authorizations that belong to a user ID. |
| user | string Only show authorizations that belong to a user name. |
| orgID | string Only show authorizations that belong to an organization ID. |
| org | string Only show authorizations that belong to a organization name. |
| token | string Find a token by value. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "authorizations": [
- {
- "status": "active",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "orgID": "string",
- "permissions": [
- {
- "action": "read",
- "resource": {
- "type": "authorizations",
- "id": "string",
- "name": "string",
- "orgID": "string",
- "org": "string"
}
}
], - "id": "string",
- "token": "string",
- "userID": "string",
- "user": "string",
- "org": "string",
- "links": {
- "self": "/api/v2/authorizations/1",
- "user": "/api/v2/users/12"
}
}
]
}| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Authorization to create
| status | string Default: "active" Enum: "active" "inactive" If inactive the token is inactive and requests using the token will be rejected. |
| description | string A description of the token. |
| orgID required | string ID of org that authorization is scoped to. |
required | Array of objects (Permission) non-empty List of permissions for an auth. An auth must have at least one Permission. |
{- "status": "active",
- "description": "string",
- "orgID": "string",
- "permissions": [
- {
- "action": "read",
- "resource": {
- "type": "authorizations",
- "id": "string",
- "name": "string",
- "orgID": "string",
- "org": "string"
}
}
]
}{- "status": "active",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "orgID": "string",
- "permissions": [
- {
- "action": "read",
- "resource": {
- "type": "authorizations",
- "id": "string",
- "name": "string",
- "orgID": "string",
- "org": "string"
}
}
], - "id": "string",
- "token": "string",
- "userID": "string",
- "user": "string",
- "org": "string",
- "links": {
- "self": "/api/v2/authorizations/1",
- "user": "/api/v2/users/12"
}
}| authID required | string The identifier of the authorization to get. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "status": "active",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "orgID": "string",
- "permissions": [
- {
- "action": "read",
- "resource": {
- "type": "authorizations",
- "id": "string",
- "name": "string",
- "orgID": "string",
- "org": "string"
}
}
], - "id": "string",
- "token": "string",
- "userID": "string",
- "user": "string",
- "org": "string",
- "links": {
- "self": "/api/v2/authorizations/1",
- "user": "/api/v2/users/12"
}
}Update an authorization's status to active or inactive.
| authID required | string The identifier of the authorization to update. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
The updated Authorization object.
| status | string Default: "active" Enum: "active" "inactive" If inactive the token is inactive and requests using the token will be rejected. |
| description | string A description of the token. |
{- "status": "active",
- "description": "string"
}{- "status": "active",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "orgID": "string",
- "permissions": [
- {
- "action": "read",
- "resource": {
- "type": "authorizations",
- "id": "string",
- "name": "string",
- "orgID": "string",
- "org": "string"
}
}
], - "id": "string",
- "token": "string",
- "userID": "string",
- "user": "string",
- "org": "string",
- "links": {
- "self": "/api/v2/authorizations/1",
- "user": "/api/v2/users/12"
}
}| authID required | string The identifier of the authorization to delete. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| offset | integer >= 0 |
| limit | integer [ 1 .. 100 ] Default: 20 |
| after | string The last resource ID from which to seek from (but not including). This is to be used instead of |
| org | string The name of the organization. |
| orgID | string The organization ID. |
| name | string Only returns buckets with a specific name. |
| id | string Only returns buckets with a specific ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "buckets": [
- {
- "links": {
- "labels": "/api/v2/buckets/1/labels",
- "members": "/api/v2/buckets/1/members",
- "org": "/api/v2/orgs/2",
- "owners": "/api/v2/buckets/1/owners",
- "self": "/api/v2/buckets/1",
- "write": "/api/v2/write?org=2&bucket=1"
}, - "id": "string",
- "type": "user",
- "name": "string",
- "description": "string",
- "orgID": "string",
- "rp": "string",
- "schemaType": "implicit",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "retentionRules": [
- {
- "type": "expire",
- "everySeconds": 86400,
- "shardGroupDurationSeconds": 0
}
], - "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
]
}
]
}| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Bucket to create
| orgID required | string |
| name required | string |
| description | string |
| rp | string |
required | Array of objects (RetentionRules) Rules to expire or retain data. No rules means data never expires. |
| schemaType | string (SchemaType) Enum: "implicit" "explicit" |
{- "orgID": "string",
- "name": "string",
- "description": "string",
- "rp": "string",
- "retentionRules": [
- {
- "type": "expire",
- "everySeconds": 86400,
- "shardGroupDurationSeconds": 0
}
], - "schemaType": "implicit"
}{- "links": {
- "labels": "/api/v2/buckets/1/labels",
- "members": "/api/v2/buckets/1/members",
- "org": "/api/v2/orgs/2",
- "owners": "/api/v2/buckets/1/owners",
- "self": "/api/v2/buckets/1",
- "write": "/api/v2/write?org=2&bucket=1"
}, - "id": "string",
- "type": "user",
- "name": "string",
- "description": "string",
- "orgID": "string",
- "rp": "string",
- "schemaType": "implicit",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "retentionRules": [
- {
- "type": "expire",
- "everySeconds": 86400,
- "shardGroupDurationSeconds": 0
}
], - "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
]
}| bucketID required | string The bucket ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "links": {
- "labels": "/api/v2/buckets/1/labels",
- "members": "/api/v2/buckets/1/members",
- "org": "/api/v2/orgs/2",
- "owners": "/api/v2/buckets/1/owners",
- "self": "/api/v2/buckets/1",
- "write": "/api/v2/write?org=2&bucket=1"
}, - "id": "string",
- "type": "user",
- "name": "string",
- "description": "string",
- "orgID": "string",
- "rp": "string",
- "schemaType": "implicit",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "retentionRules": [
- {
- "type": "expire",
- "everySeconds": 86400,
- "shardGroupDurationSeconds": 0
}
], - "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
]
}| bucketID required | string The bucket ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Bucket update to apply
| name | string |
| description | string |
Array of objects (PatchRetentionRules) Updates to rules to expire or retain data. No rules means no updates. |
{- "name": "string",
- "description": "string",
- "retentionRules": [
- {
- "type": "expire",
- "everySeconds": 86400,
- "shardGroupDurationSeconds": 0
}
]
}{- "links": {
- "labels": "/api/v2/buckets/1/labels",
- "members": "/api/v2/buckets/1/members",
- "org": "/api/v2/orgs/2",
- "owners": "/api/v2/buckets/1/owners",
- "self": "/api/v2/buckets/1",
- "write": "/api/v2/write?org=2&bucket=1"
}, - "id": "string",
- "type": "user",
- "name": "string",
- "description": "string",
- "orgID": "string",
- "rp": "string",
- "schemaType": "implicit",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "retentionRules": [
- {
- "type": "expire",
- "everySeconds": 86400,
- "shardGroupDurationSeconds": 0
}
], - "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
]
}| bucketID required | string The ID of the bucket to delete. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| bucketID required | string The bucket ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
],
}| bucketID required | string The bucket ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Label to add
| labelID | string |
{- "labelID": "string"
}{- "label": {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
},
}| bucketID required | string The bucket ID. |
| labelID required | string The ID of the label to delete. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| bucketID required | string The bucket ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "users": [
- {
- "id": "string",
- "oauthID": "string",
- "name": "string",
- "status": "active",
- "links": {
- "self": "/api/v2/users/1"
}, - "role": "member"
}
]
}| bucketID required | string The bucket ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
User to add as member
| id required | string |
| name | string |
{- "id": "string",
- "name": "string"
}{- "id": "string",
- "oauthID": "string",
- "name": "string",
- "status": "active",
- "links": {
- "self": "/api/v2/users/1"
}, - "role": "member"
}| userID required | string The ID of the member to remove. |
| bucketID required | string The bucket ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| bucketID required | string The bucket ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "users": [
- {
- "id": "string",
- "oauthID": "string",
- "name": "string",
- "status": "active",
- "links": {
- "self": "/api/v2/users/1"
}, - "role": "owner"
}
]
}| bucketID required | string The bucket ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
User to add as owner
| id required | string |
| name | string |
{- "id": "string",
- "name": "string"
}{- "id": "string",
- "oauthID": "string",
- "name": "string",
- "status": "active",
- "links": {
- "self": "/api/v2/users/1"
}, - "role": "owner"
}| userID required | string The ID of the owner to remove. |
| bucketID required | string The bucket ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}Replaces all cells in a dashboard. This is used primarily to update the positional information of all cells.
| dashboardID required | string The ID of the dashboard to update. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
| id | string |
object | |
| x | integer <int32> |
| y | integer <int32> |
| w | integer <int32> |
| h | integer <int32> |
| viewID | string The reference to a view from the views API. |
[- {
- "id": "string",
- "links": {
- "self": "string",
- "view": "string"
}, - "x": 0,
- "y": 0,
- "w": 0,
- "h": 0,
- "viewID": "string"
}
]{- "orgID": "string",
- "name": "string",
- "description": "string",
- "links": {
- "self": "/api/v2/dashboards/1",
- "cells": "/api/v2/dashboards/1/cells",
- "owners": "/api/v2/dashboards/1/owners",
- "members": "/api/v2/dashboards/1/members",
- "labels": "/api/v2/dashboards/1/labels",
- "org": "/api/v2/labels/1"
}, - "id": "string",
- "meta": {
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}, - "cells": [
- {
- "id": "string",
- "links": {
- "self": "string",
- "view": "string"
}, - "x": 0,
- "y": 0,
- "w": 0,
- "h": 0,
- "viewID": "string"
}
], - "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
]
}| dashboardID required | string The ID of the dashboard to update. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Cell that will be added
| name | string |
| x | integer <int32> |
| y | integer <int32> |
| w | integer <int32> |
| h | integer <int32> |
| usingView | string Makes a copy of the provided view. |
{- "name": "string",
- "x": 0,
- "y": 0,
- "w": 0,
- "h": 0,
- "usingView": "string"
}{- "id": "string",
- "links": {
- "self": "string",
- "view": "string"
}, - "x": 0,
- "y": 0,
- "w": 0,
- "h": 0,
- "viewID": "string"
}Updates the non positional information related to a cell. Updates to a single cell's positional data could cause grid conflicts.
| dashboardID required | string The ID of the dashboard to update. |
| cellID required | string The ID of the cell to update. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
| x | integer <int32> |
| y | integer <int32> |
| w | integer <int32> |
| h | integer <int32> |
{- "x": 0,
- "y": 0,
- "w": 0,
- "h": 0
}{- "id": "string",
- "links": {
- "self": "string",
- "view": "string"
}, - "x": 0,
- "y": 0,
- "w": 0,
- "h": 0,
- "viewID": "string"
}| dashboardID required | string The ID of the dashboard to delete. |
| cellID required | string The ID of the cell to delete. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| dashboardID required | string The dashboard ID. |
| cellID required | string The cell ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "links": {
- "self": "string"
}, - "id": "string",
- "name": "string",
- "properties": {
- "timeFormat": "string",
- "type": "line-plus-single-stat",
- "queries": [
- {
- "text": "string",
- "editMode": "builder",
- "name": "string",
- "builderConfig": {
- "buckets": [
- "string"
], - "tags": [
- {
- "key": "string",
- "values": [
- "string"
], - "aggregateFunctionType": "filter"
}
], - "functions": [
- {
- "name": "string"
}
], - "aggregateWindow": {
- "period": "string",
- "fillValues": true
}
}
}
], - "colors": [
- {
- "id": "string",
- "type": "min",
- "hex": "strings",
- "name": "string",
- "value": 0
}
], - "shape": "chronograf-v2",
- "note": "string",
- "showNoteWhenEmpty": true,
- "axes": {
- "x": {
- "bounds": [
- "string"
], - "label": "string",
- "prefix": "string",
- "suffix": "string",
- "base": "",
- "scale": "log"
}, - "y": {
- "bounds": [
- "string"
], - "label": "string",
- "prefix": "string",
- "suffix": "string",
- "base": "",
- "scale": "log"
}
}, - "staticLegend": {
- "colorizeRows": true,
- "heightRatio": 0,
- "show": true,
- "opacity": 0,
- "orientationThreshold": 0,
- "valueAxis": "string",
- "widthRatio": 0
}, - "xColumn": "string",
- "generateXAxisTicks": [
- "string"
], - "xTotalTicks": 0,
- "xTickStart": 0,
- "xTickStep": 0,
- "yColumn": "string",
- "generateYAxisTicks": [
- "string"
], - "yTotalTicks": 0,
- "yTickStart": 0,
- "yTickStep": 0,
- "shadeBelow": true,
- "hoverDimension": "auto",
- "position": "overlaid",
- "prefix": "string",
- "suffix": "string",
- "decimalPlaces": {
- "isEnforced": true,
- "digits": 0
}, - "legendColorizeRows": true,
- "legendHide": true,
- "legendOpacity": 0,
- "legendOrientationThreshold": 0
}
}| dashboardID required | string The ID of the dashboard to update. |
| cellID required | string The ID of the cell to update. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
| name required | string |
required | LinePlusSingleStatProperties (object) or XYViewProperties (object) or SingleStatViewProperties (object) or HistogramViewProperties (object) or GaugeViewProperties (object) or TableViewProperties (object) or SimpleTableViewProperties (object) or MarkdownViewProperties (object) or CheckViewProperties (object) or ScatterViewProperties (object) or HeatmapViewProperties (object) or MosaicViewProperties (object) or BandViewProperties (object) or GeoViewProperties (object) (ViewProperties) |
{- "name": "string",
- "properties": {
- "timeFormat": "string",
- "type": "line-plus-single-stat",
- "queries": [
- {
- "text": "string",
- "editMode": "builder",
- "name": "string",
- "builderConfig": {
- "buckets": [
- "string"
], - "tags": [
- {
- "key": "string",
- "values": [
- "string"
], - "aggregateFunctionType": "filter"
}
], - "functions": [
- {
- "name": "string"
}
], - "aggregateWindow": {
- "period": "string",
- "fillValues": true
}
}
}
], - "colors": [
- {
- "id": "string",
- "type": "min",
- "hex": "strings",
- "name": "string",
- "value": 0
}
], - "shape": "chronograf-v2",
- "note": "string",
- "showNoteWhenEmpty": true,
- "axes": {
- "x": {
- "bounds": [
- "string"
], - "label": "string",
- "prefix": "string",
- "suffix": "string",
- "base": "",
- "scale": "log"
}, - "y": {
- "bounds": [
- "string"
], - "label": "string",
- "prefix": "string",
- "suffix": "string",
- "base": "",
- "scale": "log"
}
}, - "staticLegend": {
- "colorizeRows": true,
- "heightRatio": 0,
- "show": true,
- "opacity": 0,
- "orientationThreshold": 0,
- "valueAxis": "string",
- "widthRatio": 0
}, - "xColumn": "string",
- "generateXAxisTicks": [
- "string"
], - "xTotalTicks": 0,
- "xTickStart": 0,
- "xTickStep": 0,
- "yColumn": "string",
- "generateYAxisTicks": [
- "string"
], - "yTotalTicks": 0,
- "yTickStart": 0,
- "yTickStep": 0,
- "shadeBelow": true,
- "hoverDimension": "auto",
- "position": "overlaid",
- "prefix": "string",
- "suffix": "string",
- "decimalPlaces": {
- "isEnforced": true,
- "digits": 0
}, - "legendColorizeRows": true,
- "legendHide": true,
- "legendOpacity": 0,
- "legendOrientationThreshold": 0
}
}{- "links": {
- "self": "string"
}, - "id": "string",
- "name": "string",
- "properties": {
- "timeFormat": "string",
- "type": "line-plus-single-stat",
- "queries": [
- {
- "text": "string",
- "editMode": "builder",
- "name": "string",
- "builderConfig": {
- "buckets": [
- "string"
], - "tags": [
- {
- "key": "string",
- "values": [
- "string"
], - "aggregateFunctionType": "filter"
}
], - "functions": [
- {
- "name": "string"
}
], - "aggregateWindow": {
- "period": "string",
- "fillValues": true
}
}
}
], - "colors": [
- {
- "id": "string",
- "type": "min",
- "hex": "strings",
- "name": "string",
- "value": 0
}
], - "shape": "chronograf-v2",
- "note": "string",
- "showNoteWhenEmpty": true,
- "axes": {
- "x": {
- "bounds": [
- "string"
], - "label": "string",
- "prefix": "string",
- "suffix": "string",
- "base": "",
- "scale": "log"
}, - "y": {
- "bounds": [
- "string"
], - "label": "string",
- "prefix": "string",
- "suffix": "string",
- "base": "",
- "scale": "log"
}
}, - "staticLegend": {
- "colorizeRows": true,
- "heightRatio": 0,
- "show": true,
- "opacity": 0,
- "orientationThreshold": 0,
- "valueAxis": "string",
- "widthRatio": 0
}, - "xColumn": "string",
- "generateXAxisTicks": [
- "string"
], - "xTotalTicks": 0,
- "xTickStart": 0,
- "xTickStep": 0,
- "yColumn": "string",
- "generateYAxisTicks": [
- "string"
], - "yTotalTicks": 0,
- "yTickStart": 0,
- "yTickStep": 0,
- "shadeBelow": true,
- "hoverDimension": "auto",
- "position": "overlaid",
- "prefix": "string",
- "suffix": "string",
- "decimalPlaces": {
- "isEnforced": true,
- "digits": 0
}, - "legendColorizeRows": true,
- "legendHide": true,
- "legendOpacity": 0,
- "legendOrientationThreshold": 0
}
}| offset | integer >= 0 |
| limit | integer [ 1 .. 100 ] Default: 20 |
| orgID required | string Only show checks that belong to a specific organization ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "checks": [
- {
- "id": "string",
- "name": "string",
- "orgID": "string",
- "taskID": "string",
- "ownerID": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "query": {
- "text": "string",
- "editMode": "builder",
- "name": "string",
- "builderConfig": {
- "buckets": [
- "string"
], - "tags": [
- {
- "key": "string",
- "values": [
- "string"
], - "aggregateFunctionType": "filter"
}
], - "functions": [
- {
- "name": "string"
}
], - "aggregateWindow": {
- "period": "string",
- "fillValues": true
}
}
}, - "status": "active",
- "description": "string",
- "latestCompleted": "2019-08-24T14:15:22Z",
- "lastRunStatus": "failed",
- "lastRunError": "string",
- "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
], - "links": {
- "self": "/api/v2/checks/1",
- "labels": "/api/v2/checks/1/labels",
- "members": "/api/v2/checks/1/members",
- "owners": "/api/v2/checks/1/owners",
- "query": "/api/v2/checks/1/query"
}, - "type": "deadman",
- "timeSince": "string",
- "staleTime": "string",
- "reportZero": true,
- "level": "UNKNOWN",
- "every": "string",
- "offset": "string",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "statusMessageTemplate": "string"
}
],
}Check to create
| name required | string |
| orgID required | string The ID of the organization that owns this check. |
| taskID | string The ID of the task associated with this check. |
required | object (DashboardQuery) |
| status | string (TaskStatusType) Enum: "active" "inactive" |
| description | string An optional description of the check. |
Array of objects (Labels) | |
| type required | string deadman PostCheck Check custom threshold deadman |
| timeSince | string String duration before deadman triggers. |
| staleTime | string String duration for time that a series is considered stale and should not trigger deadman. |
| reportZero | boolean If only zero values reported since time, trigger an alert |
| level | string (CheckStatusLevel) Enum: "UNKNOWN" "OK" "INFO" "CRIT" "WARN" The state to record if check matches a criteria. |
| every | string Check repetition interval. |
| offset | string Duration to delay after the schedule, before executing check. |
Array of objects List of tags to write to each status. | |
| statusMessageTemplate | string The template used to generate and write a status message. |
{- "name": "string",
- "orgID": "string",
- "taskID": "string",
- "query": {
- "text": "string",
- "editMode": "builder",
- "name": "string",
- "builderConfig": {
- "buckets": [
- "string"
], - "tags": [
- {
- "key": "string",
- "values": [
- "string"
], - "aggregateFunctionType": "filter"
}
], - "functions": [
- {
- "name": "string"
}
], - "aggregateWindow": {
- "period": "string",
- "fillValues": true
}
}
}, - "status": "active",
- "description": "string",
- "labels": [
- {
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
], - "type": "deadman",
- "timeSince": "string",
- "staleTime": "string",
- "reportZero": true,
- "level": "UNKNOWN",
- "every": "string",
- "offset": "string",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "statusMessageTemplate": "string"
}{- "id": "string",
- "name": "string",
- "orgID": "string",
- "taskID": "string",
- "ownerID": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "query": {
- "text": "string",
- "editMode": "builder",
- "name": "string",
- "builderConfig": {
- "buckets": [
- "string"
], - "tags": [
- {
- "key": "string",
- "values": [
- "string"
], - "aggregateFunctionType": "filter"
}
], - "functions": [
- {
- "name": "string"
}
], - "aggregateWindow": {
- "period": "string",
- "fillValues": true
}
}
}, - "status": "active",
- "description": "string",
- "latestCompleted": "2019-08-24T14:15:22Z",
- "lastRunStatus": "failed",
- "lastRunError": "string",
- "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
], - "links": {
- "self": "/api/v2/checks/1",
- "labels": "/api/v2/checks/1/labels",
- "members": "/api/v2/checks/1/members",
- "owners": "/api/v2/checks/1/owners",
- "query": "/api/v2/checks/1/query"
}, - "type": "deadman",
- "timeSince": "string",
- "staleTime": "string",
- "reportZero": true,
- "level": "UNKNOWN",
- "every": "string",
- "offset": "string",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "statusMessageTemplate": "string"
}| checkID required | string The check ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "id": "string",
- "name": "string",
- "orgID": "string",
- "taskID": "string",
- "ownerID": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "query": {
- "text": "string",
- "editMode": "builder",
- "name": "string",
- "builderConfig": {
- "buckets": [
- "string"
], - "tags": [
- {
- "key": "string",
- "values": [
- "string"
], - "aggregateFunctionType": "filter"
}
], - "functions": [
- {
- "name": "string"
}
], - "aggregateWindow": {
- "period": "string",
- "fillValues": true
}
}
}, - "status": "active",
- "description": "string",
- "latestCompleted": "2019-08-24T14:15:22Z",
- "lastRunStatus": "failed",
- "lastRunError": "string",
- "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
], - "links": {
- "self": "/api/v2/checks/1",
- "labels": "/api/v2/checks/1/labels",
- "members": "/api/v2/checks/1/members",
- "owners": "/api/v2/checks/1/owners",
- "query": "/api/v2/checks/1/query"
}, - "type": "deadman",
- "timeSince": "string",
- "staleTime": "string",
- "reportZero": true,
- "level": "UNKNOWN",
- "every": "string",
- "offset": "string",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "statusMessageTemplate": "string"
}| checkID required | string The check ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Check update to apply
| name required | string |
| orgID required | string The ID of the organization that owns this check. |
| taskID | string The ID of the task associated with this check. |
required | object (DashboardQuery) |
| status | string (TaskStatusType) Enum: "active" "inactive" |
| description | string An optional description of the check. |
Array of objects (Labels) | |
| type required | string deadman PostCheck Check custom threshold deadman |
| timeSince | string String duration before deadman triggers. |
| staleTime | string String duration for time that a series is considered stale and should not trigger deadman. |
| reportZero | boolean If only zero values reported since time, trigger an alert |
| level | string (CheckStatusLevel) Enum: "UNKNOWN" "OK" "INFO" "CRIT" "WARN" The state to record if check matches a criteria. |
| every | string Check repetition interval. |
| offset | string Duration to delay after the schedule, before executing check. |
Array of objects List of tags to write to each status. | |
| statusMessageTemplate | string The template used to generate and write a status message. |
{- "name": "string",
- "orgID": "string",
- "taskID": "string",
- "query": {
- "text": "string",
- "editMode": "builder",
- "name": "string",
- "builderConfig": {
- "buckets": [
- "string"
], - "tags": [
- {
- "key": "string",
- "values": [
- "string"
], - "aggregateFunctionType": "filter"
}
], - "functions": [
- {
- "name": "string"
}
], - "aggregateWindow": {
- "period": "string",
- "fillValues": true
}
}
}, - "status": "active",
- "description": "string",
- "labels": [
- {
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
], - "type": "deadman",
- "timeSince": "string",
- "staleTime": "string",
- "reportZero": true,
- "level": "UNKNOWN",
- "every": "string",
- "offset": "string",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "statusMessageTemplate": "string"
}{- "id": "string",
- "name": "string",
- "orgID": "string",
- "taskID": "string",
- "ownerID": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "query": {
- "text": "string",
- "editMode": "builder",
- "name": "string",
- "builderConfig": {
- "buckets": [
- "string"
], - "tags": [
- {
- "key": "string",
- "values": [
- "string"
], - "aggregateFunctionType": "filter"
}
], - "functions": [
- {
- "name": "string"
}
], - "aggregateWindow": {
- "period": "string",
- "fillValues": true
}
}
}, - "status": "active",
- "description": "string",
- "latestCompleted": "2019-08-24T14:15:22Z",
- "lastRunStatus": "failed",
- "lastRunError": "string",
- "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
], - "links": {
- "self": "/api/v2/checks/1",
- "labels": "/api/v2/checks/1/labels",
- "members": "/api/v2/checks/1/members",
- "owners": "/api/v2/checks/1/owners",
- "query": "/api/v2/checks/1/query"
}, - "type": "deadman",
- "timeSince": "string",
- "staleTime": "string",
- "reportZero": true,
- "level": "UNKNOWN",
- "every": "string",
- "offset": "string",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "statusMessageTemplate": "string"
}| checkID required | string The check ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Check update to apply
| name | string |
| description | string |
| status | string Enum: "active" "inactive" |
{- "name": "string",
- "description": "string",
- "status": "active"
}{- "id": "string",
- "name": "string",
- "orgID": "string",
- "taskID": "string",
- "ownerID": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "query": {
- "text": "string",
- "editMode": "builder",
- "name": "string",
- "builderConfig": {
- "buckets": [
- "string"
], - "tags": [
- {
- "key": "string",
- "values": [
- "string"
], - "aggregateFunctionType": "filter"
}
], - "functions": [
- {
- "name": "string"
}
], - "aggregateWindow": {
- "period": "string",
- "fillValues": true
}
}
}, - "status": "active",
- "description": "string",
- "latestCompleted": "2019-08-24T14:15:22Z",
- "lastRunStatus": "failed",
- "lastRunError": "string",
- "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
], - "links": {
- "self": "/api/v2/checks/1",
- "labels": "/api/v2/checks/1/labels",
- "members": "/api/v2/checks/1/members",
- "owners": "/api/v2/checks/1/owners",
- "query": "/api/v2/checks/1/query"
}, - "type": "deadman",
- "timeSince": "string",
- "staleTime": "string",
- "reportZero": true,
- "level": "UNKNOWN",
- "every": "string",
- "offset": "string",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "statusMessageTemplate": "string"
}| checkID required | string The check ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| checkID required | string The check ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
],
}| checkID required | string The check ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Label to add
| labelID | string |
{- "labelID": "string"
}{- "label": {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
},
}| checkID required | string The check ID. |
| labelID required | string The ID of the label to delete. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| orgID | string Specifies the organization ID to filter on |
| org | string Specifies the organization name to filter on |
| id | string Specifies the mapping ID to filter on |
| bucketID | string Specifies the bucket ID to filter on |
| default | boolean Specifies filtering on default |
| db | string Specifies the database to filter on |
| rp | string Specifies the retention policy to filter on |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "content": [
- {
- "id": "string",
- "orgID": "string",
- "bucketID": "string",
- "database": "string",
- "retention_policy": "string",
- "default": true,
}
]
}| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
The database retention policy mapping to add
| orgID | string the organization ID that owns this mapping. |
| org | string the organization that owns this mapping. |
| bucketID required | string the bucket ID used as target for the translation. |
| database required | string InfluxDB v1 database |
| retention_policy required | string InfluxDB v1 retention policy |
| default | boolean Specify if this mapping represents the default retention policy for the database specificed. |
{- "orgID": "string",
- "org": "string",
- "bucketID": "string",
- "database": "string",
- "retention_policy": "string",
- "default": true
}{- "id": "string",
- "orgID": "string",
- "bucketID": "string",
- "database": "string",
- "retention_policy": "string",
- "default": true,
}| dbrpID required | string The database retention policy mapping ID |
| orgID | string Specifies the organization ID of the mapping |
| org | string Specifies the organization name of the mapping |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "content": {
- "id": "string",
- "orgID": "string",
- "bucketID": "string",
- "database": "string",
- "retention_policy": "string",
- "default": true,
}
}| dbrpID required | string The database retention policy mapping. |
| orgID | string Specifies the organization ID of the mapping |
| org | string Specifies the organization name of the mapping |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Database retention policy update to apply
| retention_policy | string InfluxDB v1 retention policy |
| default | boolean |
{- "retention_policy": "string",
- "default": true
}{- "content": {
- "id": "string",
- "orgID": "string",
- "bucketID": "string",
- "database": "string",
- "retention_policy": "string",
- "default": true,
}
}| dbrpID required | string The database retention policy mapping |
| orgID | string Specifies the organization ID of the mapping |
| org | string Specifies the organization name of the mapping |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| dashboardID required | string The ID of the dashboard to update. |
| include | string Value: "properties" Includes the cell view properties in the response if set to |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "orgID": "string",
- "name": "string",
- "description": "string",
- "links": {
- "self": "/api/v2/dashboards/1",
- "cells": "/api/v2/dashboards/1/cells",
- "owners": "/api/v2/dashboards/1/owners",
- "members": "/api/v2/dashboards/1/members",
- "labels": "/api/v2/dashboards/1/labels",
- "org": "/api/v2/labels/1"
}, - "id": "string",
- "meta": {
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}, - "cells": [
- {
- "id": "string",
- "links": {
- "self": "string",
- "view": "string"
}, - "x": 0,
- "y": 0,
- "w": 0,
- "h": 0,
- "viewID": "string"
}
], - "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
]
}| dashboardID required | string The ID of the dashboard to update. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Patching of a dashboard
| name | string optional, when provided will replace the name |
| description | string optional, when provided will replace the description |
object (CellWithViewProperties) |
{- "name": "string",
- "description": "string",
- "cells": {
- "id": "string",
- "links": {
- "self": "string",
- "view": "string"
}, - "x": 0,
- "y": 0,
- "w": 0,
- "h": 0,
- "viewID": "string",
- "name": "string",
- "properties": {
- "timeFormat": "string",
- "type": "line-plus-single-stat",
- "queries": [
- {
- "text": "string",
- "editMode": "builder",
- "name": "string",
- "builderConfig": {
- "buckets": [
- "string"
], - "tags": [
- {
- "key": "string",
- "values": [
- "string"
], - "aggregateFunctionType": "filter"
}
], - "functions": [
- {
- "name": "string"
}
], - "aggregateWindow": {
- "period": "string",
- "fillValues": true
}
}
}
], - "colors": [
- {
- "id": "string",
- "type": "min",
- "hex": "strings",
- "name": "string",
- "value": 0
}
], - "shape": "chronograf-v2",
- "note": "string",
- "showNoteWhenEmpty": true,
- "axes": {
- "x": {
- "bounds": [
- "string"
], - "label": "string",
- "prefix": "string",
- "suffix": "string",
- "base": "",
- "scale": "log"
}, - "y": {
- "bounds": [
- "string"
], - "label": "string",
- "prefix": "string",
- "suffix": "string",
- "base": "",
- "scale": "log"
}
}, - "staticLegend": {
- "colorizeRows": true,
- "heightRatio": 0,
- "show": true,
- "opacity": 0,
- "orientationThreshold": 0,
- "valueAxis": "string",
- "widthRatio": 0
}, - "xColumn": "string",
- "generateXAxisTicks": [
- "string"
], - "xTotalTicks": 0,
- "xTickStart": 0,
- "xTickStep": 0,
- "yColumn": "string",
- "generateYAxisTicks": [
- "string"
], - "yTotalTicks": 0,
- "yTickStart": 0,
- "yTickStep": 0,
- "shadeBelow": true,
- "hoverDimension": "auto",
- "position": "overlaid",
- "prefix": "string",
- "suffix": "string",
- "decimalPlaces": {
- "isEnforced": true,
- "digits": 0
}, - "legendColorizeRows": true,
- "legendHide": true,
- "legendOpacity": 0,
- "legendOrientationThreshold": 0
}
}
}{- "orgID": "string",
- "name": "string",
- "description": "string",
- "links": {
- "self": "/api/v2/dashboards/1",
- "cells": "/api/v2/dashboards/1/cells",
- "owners": "/api/v2/dashboards/1/owners",
- "members": "/api/v2/dashboards/1/members",
- "labels": "/api/v2/dashboards/1/labels",
- "org": "/api/v2/labels/1"
}, - "id": "string",
- "meta": {
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}, - "cells": [
- {
- "id": "string",
- "links": {
- "self": "string",
- "view": "string"
}, - "x": 0,
- "y": 0,
- "w": 0,
- "h": 0,
- "viewID": "string"
}
], - "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
]
}| dashboardID required | string The ID of the dashboard to update. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}Replaces all cells in a dashboard. This is used primarily to update the positional information of all cells.
| dashboardID required | string The ID of the dashboard to update. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
| id | string |
object | |
| x | integer <int32> |
| y | integer <int32> |
| w | integer <int32> |
| h | integer <int32> |
| viewID | string The reference to a view from the views API. |
[- {
- "id": "string",
- "links": {
- "self": "string",
- "view": "string"
}, - "x": 0,
- "y": 0,
- "w": 0,
- "h": 0,
- "viewID": "string"
}
]{- "orgID": "string",
- "name": "string",
- "description": "string",
- "links": {
- "self": "/api/v2/dashboards/1",
- "cells": "/api/v2/dashboards/1/cells",
- "owners": "/api/v2/dashboards/1/owners",
- "members": "/api/v2/dashboards/1/members",
- "labels": "/api/v2/dashboards/1/labels",
- "org": "/api/v2/labels/1"
}, - "id": "string",
- "meta": {
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}, - "cells": [
- {
- "id": "string",
- "links": {
- "self": "string",
- "view": "string"
}, - "x": 0,
- "y": 0,
- "w": 0,
- "h": 0,
- "viewID": "string"
}
], - "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
]
}| dashboardID required | string The ID of the dashboard to update. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Cell that will be added
| name | string |
| x | integer <int32> |
| y | integer <int32> |
| w | integer <int32> |
| h | integer <int32> |
| usingView | string Makes a copy of the provided view. |
{- "name": "string",
- "x": 0,
- "y": 0,
- "w": 0,
- "h": 0,
- "usingView": "string"
}{- "id": "string",
- "links": {
- "self": "string",
- "view": "string"
}, - "x": 0,
- "y": 0,
- "w": 0,
- "h": 0,
- "viewID": "string"
}Updates the non positional information related to a cell. Updates to a single cell's positional data could cause grid conflicts.
| dashboardID required | string The ID of the dashboard to update. |
| cellID required | string The ID of the cell to update. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
| x | integer <int32> |
| y | integer <int32> |
| w | integer <int32> |
| h | integer <int32> |
{- "x": 0,
- "y": 0,
- "w": 0,
- "h": 0
}{- "id": "string",
- "links": {
- "self": "string",
- "view": "string"
}, - "x": 0,
- "y": 0,
- "w": 0,
- "h": 0,
- "viewID": "string"
}| dashboardID required | string The ID of the dashboard to delete. |
| cellID required | string The ID of the cell to delete. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| dashboardID required | string The dashboard ID. |
| cellID required | string The cell ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "links": {
- "self": "string"
}, - "id": "string",
- "name": "string",
- "properties": {
- "timeFormat": "string",
- "type": "line-plus-single-stat",
- "queries": [
- {
- "text": "string",
- "editMode": "builder",
- "name": "string",
- "builderConfig": {
- "buckets": [
- "string"
], - "tags": [
- {
- "key": "string",
- "values": [
- "string"
], - "aggregateFunctionType": "filter"
}
], - "functions": [
- {
- "name": "string"
}
], - "aggregateWindow": {
- "period": "string",
- "fillValues": true
}
}
}
], - "colors": [
- {
- "id": "string",
- "type": "min",
- "hex": "strings",
- "name": "string",
- "value": 0
}
], - "shape": "chronograf-v2",
- "note": "string",
- "showNoteWhenEmpty": true,
- "axes": {
- "x": {
- "bounds": [
- "string"
], - "label": "string",
- "prefix": "string",
- "suffix": "string",
- "base": "",
- "scale": "log"
}, - "y": {
- "bounds": [
- "string"
], - "label": "string",
- "prefix": "string",
- "suffix": "string",
- "base": "",
- "scale": "log"
}
}, - "staticLegend": {
- "colorizeRows": true,
- "heightRatio": 0,
- "show": true,
- "opacity": 0,
- "orientationThreshold": 0,
- "valueAxis": "string",
- "widthRatio": 0
}, - "xColumn": "string",
- "generateXAxisTicks": [
- "string"
], - "xTotalTicks": 0,
- "xTickStart": 0,
- "xTickStep": 0,
- "yColumn": "string",
- "generateYAxisTicks": [
- "string"
], - "yTotalTicks": 0,
- "yTickStart": 0,
- "yTickStep": 0,
- "shadeBelow": true,
- "hoverDimension": "auto",
- "position": "overlaid",
- "prefix": "string",
- "suffix": "string",
- "decimalPlaces": {
- "isEnforced": true,
- "digits": 0
}, - "legendColorizeRows": true,
- "legendHide": true,
- "legendOpacity": 0,
- "legendOrientationThreshold": 0
}
}| dashboardID required | string The ID of the dashboard to update. |
| cellID required | string The ID of the cell to update. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
| name required | string |
required | LinePlusSingleStatProperties (object) or XYViewProperties (object) or SingleStatViewProperties (object) or HistogramViewProperties (object) or GaugeViewProperties (object) or TableViewProperties (object) or SimpleTableViewProperties (object) or MarkdownViewProperties (object) or CheckViewProperties (object) or ScatterViewProperties (object) or HeatmapViewProperties (object) or MosaicViewProperties (object) or BandViewProperties (object) or GeoViewProperties (object) (ViewProperties) |
{- "name": "string",
- "properties": {
- "timeFormat": "string",
- "type": "line-plus-single-stat",
- "queries": [
- {
- "text": "string",
- "editMode": "builder",
- "name": "string",
- "builderConfig": {
- "buckets": [
- "string"
], - "tags": [
- {
- "key": "string",
- "values": [
- "string"
], - "aggregateFunctionType": "filter"
}
], - "functions": [
- {
- "name": "string"
}
], - "aggregateWindow": {
- "period": "string",
- "fillValues": true
}
}
}
], - "colors": [
- {
- "id": "string",
- "type": "min",
- "hex": "strings",
- "name": "string",
- "value": 0
}
], - "shape": "chronograf-v2",
- "note": "string",
- "showNoteWhenEmpty": true,
- "axes": {
- "x": {
- "bounds": [
- "string"
], - "label": "string",
- "prefix": "string",
- "suffix": "string",
- "base": "",
- "scale": "log"
}, - "y": {
- "bounds": [
- "string"
], - "label": "string",
- "prefix": "string",
- "suffix": "string",
- "base": "",
- "scale": "log"
}
}, - "staticLegend": {
- "colorizeRows": true,
- "heightRatio": 0,
- "show": true,
- "opacity": 0,
- "orientationThreshold": 0,
- "valueAxis": "string",
- "widthRatio": 0
}, - "xColumn": "string",
- "generateXAxisTicks": [
- "string"
], - "xTotalTicks": 0,
- "xTickStart": 0,
- "xTickStep": 0,
- "yColumn": "string",
- "generateYAxisTicks": [
- "string"
], - "yTotalTicks": 0,
- "yTickStart": 0,
- "yTickStep": 0,
- "shadeBelow": true,
- "hoverDimension": "auto",
- "position": "overlaid",
- "prefix": "string",
- "suffix": "string",
- "decimalPlaces": {
- "isEnforced": true,
- "digits": 0
}, - "legendColorizeRows": true,
- "legendHide": true,
- "legendOpacity": 0,
- "legendOrientationThreshold": 0
}
}{- "links": {
- "self": "string"
}, - "id": "string",
- "name": "string",
- "properties": {
- "timeFormat": "string",
- "type": "line-plus-single-stat",
- "queries": [
- {
- "text": "string",
- "editMode": "builder",
- "name": "string",
- "builderConfig": {
- "buckets": [
- "string"
], - "tags": [
- {
- "key": "string",
- "values": [
- "string"
], - "aggregateFunctionType": "filter"
}
], - "functions": [
- {
- "name": "string"
}
], - "aggregateWindow": {
- "period": "string",
- "fillValues": true
}
}
}
], - "colors": [
- {
- "id": "string",
- "type": "min",
- "hex": "strings",
- "name": "string",
- "value": 0
}
], - "shape": "chronograf-v2",
- "note": "string",
- "showNoteWhenEmpty": true,
- "axes": {
- "x": {
- "bounds": [
- "string"
], - "label": "string",
- "prefix": "string",
- "suffix": "string",
- "base": "",
- "scale": "log"
}, - "y": {
- "bounds": [
- "string"
], - "label": "string",
- "prefix": "string",
- "suffix": "string",
- "base": "",
- "scale": "log"
}
}, - "staticLegend": {
- "colorizeRows": true,
- "heightRatio": 0,
- "show": true,
- "opacity": 0,
- "orientationThreshold": 0,
- "valueAxis": "string",
- "widthRatio": 0
}, - "xColumn": "string",
- "generateXAxisTicks": [
- "string"
], - "xTotalTicks": 0,
- "xTickStart": 0,
- "xTickStep": 0,
- "yColumn": "string",
- "generateYAxisTicks": [
- "string"
], - "yTotalTicks": 0,
- "yTickStart": 0,
- "yTickStep": 0,
- "shadeBelow": true,
- "hoverDimension": "auto",
- "position": "overlaid",
- "prefix": "string",
- "suffix": "string",
- "decimalPlaces": {
- "isEnforced": true,
- "digits": 0
}, - "legendColorizeRows": true,
- "legendHide": true,
- "legendOpacity": 0,
- "legendOrientationThreshold": 0
}
}| dashboardID required | string The dashboard ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
],
}| dashboardID required | string The dashboard ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Label to add
| labelID | string |
{- "labelID": "string"
}{- "label": {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
},
}| dashboardID required | string The dashboard ID. |
| labelID required | string The ID of the label to delete. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| dashboardID required | string The dashboard ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "users": [
- {
- "id": "string",
- "oauthID": "string",
- "name": "string",
- "status": "active",
- "links": {
- "self": "/api/v2/users/1"
}, - "role": "member"
}
]
}| dashboardID required | string The dashboard ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
User to add as member
| id required | string |
| name | string |
{- "id": "string",
- "name": "string"
}{- "id": "string",
- "oauthID": "string",
- "name": "string",
- "status": "active",
- "links": {
- "self": "/api/v2/users/1"
}, - "role": "member"
}| userID required | string The ID of the member to remove. |
| dashboardID required | string The dashboard ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| dashboardID required | string The dashboard ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "users": [
- {
- "id": "string",
- "oauthID": "string",
- "name": "string",
- "status": "active",
- "links": {
- "self": "/api/v2/users/1"
}, - "role": "owner"
}
]
}| dashboardID required | string The dashboard ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
User to add as owner
| id required | string |
| name | string |
{- "id": "string",
- "name": "string"
}{- "id": "string",
- "oauthID": "string",
- "name": "string",
- "status": "active",
- "links": {
- "self": "/api/v2/users/1"
}, - "role": "owner"
}| userID required | string The ID of the owner to remove. |
| dashboardID required | string The dashboard ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Dashboard to create
| orgID required | string The ID of the organization that owns the dashboard. |
| name required | string The user-facing name of the dashboard. |
| description | string The user-facing description of the dashboard. |
{- "orgID": "string",
- "name": "string",
- "description": "string"
}{- "orgID": "string",
- "name": "string",
- "description": "string",
- "links": {
- "self": "/api/v2/dashboards/1",
- "cells": "/api/v2/dashboards/1/cells",
- "owners": "/api/v2/dashboards/1/owners",
- "members": "/api/v2/dashboards/1/members",
- "labels": "/api/v2/dashboards/1/labels",
- "org": "/api/v2/labels/1"
}, - "id": "string",
- "meta": {
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}, - "cells": [
- {
- "id": "string",
- "links": {
- "self": "string",
- "view": "string"
}, - "x": 0,
- "y": 0,
- "w": 0,
- "h": 0,
- "viewID": "string"
}
], - "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
]
}| offset | integer >= 0 |
| descending | boolean Default: false |
| limit | integer [ -1 .. 100 ] Default: 20 The non-zero number of dashboards to return |
| owner | string A user identifier. Returns only dashboards where this user has the |
| sortBy | string Enum: "ID" "CreatedAt" "UpdatedAt" The column to sort by. |
| id | Array of strings A list of dashboard identifiers. Returns only the listed dashboards. If both |
| orgID | string The identifier of the organization. |
| org | string The name of the organization. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "dashboards": [
- {
- "orgID": "string",
- "name": "string",
- "description": "string",
- "links": {
- "self": "/api/v2/dashboards/1",
- "cells": "/api/v2/dashboards/1/cells",
- "owners": "/api/v2/dashboards/1/owners",
- "members": "/api/v2/dashboards/1/members",
- "labels": "/api/v2/dashboards/1/labels",
- "org": "/api/v2/labels/1"
}, - "id": "string",
- "meta": {
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}, - "cells": [
- {
- "id": "string",
- "links": {
- "self": "string",
- "view": "string"
}, - "x": 0,
- "y": 0,
- "w": 0,
- "h": 0,
- "viewID": "string"
}
], - "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
]
}
]
}| org | string Specifies the organization to delete data from. |
| bucket | string Specifies the bucket to delete data from. |
| orgID | string Specifies the organization ID of the resource. |
| bucketID | string Specifies the bucket ID to delete data from. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Deletes data from an InfluxDB bucket.
| start required | string <date-time> RFC3339Nano |
| stop required | string <date-time> RFC3339Nano |
| predicate | string InfluxQL-like delete statement |
{- "start": "2019-08-24T14:15:22Z",
- "stop": "2019-08-24T14:15:22Z",
- "predicate": "tag1=\"value1\" and (tag2=\"value2\" and tag3!=\"value3\")"
}{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}{- "buckets": [
- {
- "links": {
- "labels": "/api/v2/buckets/1/labels",
- "members": "/api/v2/buckets/1/members",
- "org": "/api/v2/orgs/2",
- "owners": "/api/v2/buckets/1/owners",
- "self": "/api/v2/buckets/1",
- "write": "/api/v2/write?org=2&bucket=1"
}, - "id": "string",
- "type": "demodata",
- "name": "string",
- "description": "string",
- "orgID": "string",
- "rp": "string",
- "schemaType": "implicit",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "retentionRules": [
- {
- "type": "expire",
- "everySeconds": 86400,
- "shardGroupDurationSeconds": 0
}
], - "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
]
}
]
}Label to create
| orgID required | string |
| name required | string |
object Key/Value pairs associated with this label. Keys can be removed by sending an update with an empty value. |
{- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}{- "label": {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
},
}| orgID | string The organization ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
],
}| labelID required | string The ID of the label to update. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "label": {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
},
}| labelID required | string The ID of the label to update. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Label update
| name | string |
object Key/Value pairs associated with this label. Keys can be removed by sending an update with an empty value. |
{- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}{- "label": {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
},
}| labelID required | string The ID of the label to delete. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| orgID required | string The identifier of the organization. |
{- "limits": {
- "orgID": "string",
- "rate": {
- "readKBs": 0,
- "concurrentReadRequests": 0,
- "writeKBs": 0,
- "concurrentWriteRequests": 0,
- "cardinality": 0,
- "concurrentDeleteRequests": 0,
- "deleteRequestsPerSecond": 0
}, - "bucket": {
- "maxBuckets": 0,
- "maxRetentionDuration": 0
}, - "task": {
- "maxTasks": 0
}, - "dashboard": {
- "maxDashboards": 0
}, - "check": {
- "maxChecks": 0
}, - "notificationRule": {
- "maxNotifications": 0,
- "blockedNotificationRules": "http,pagerduty"
}, - "notificationEndpoint": {
- "blockedNotificationEndpoints": "http,pagerduty"
}, - "features": {
- "allowDelete": true
}
}
}| offset | integer >= 0 |
| limit | integer [ 1 .. 100 ] Default: 20 |
| orgID required | string Only show notification endpoints that belong to specific organization ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "notificationEndpoints": [
- {
- "id": "string",
- "orgID": "string",
- "userID": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "description": "string",
- "name": "string",
- "status": "active",
- "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
], - "links": {
- "self": "/api/v2/notificationEndpoints/1",
- "labels": "/api/v2/notificationEndpoints/1/labels",
- "members": "/api/v2/notificationEndpoints/1/members",
- "owners": "/api/v2/notificationEndpoints/1/owners"
}, - "type": "slack",
- "url": "string",
- "token": "string"
}
],
}Notification endpoint to create
| id | string |
| orgID | string |
| userID | string |
| description | string An optional description of the notification endpoint. |
| name required | string |
| status | string Default: "active" Enum: "active" "inactive" The status of the endpoint. |
Array of objects (Labels) | |
| type required | string (NotificationEndpointType) slack PostNotificationEndpoint NotificationEndpoint slack pagerduty http telegram |
| url | string Specifies the URL of the Slack endpoint. Specify either |
| token | string Specifies the API token string. Specify either |
{- "id": "string",
- "orgID": "string",
- "userID": "string",
- "description": "string",
- "name": "string",
- "status": "active",
- "labels": [
- {
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
], - "type": "slack",
- "url": "string",
- "token": "string"
}{- "id": "string",
- "orgID": "string",
- "userID": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "description": "string",
- "name": "string",
- "status": "active",
- "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
], - "links": {
- "self": "/api/v2/notificationEndpoints/1",
- "labels": "/api/v2/notificationEndpoints/1/labels",
- "members": "/api/v2/notificationEndpoints/1/members",
- "owners": "/api/v2/notificationEndpoints/1/owners"
}, - "type": "slack",
- "url": "string",
- "token": "string"
}| endpointID required | string The notification endpoint ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "id": "string",
- "orgID": "string",
- "userID": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "description": "string",
- "name": "string",
- "status": "active",
- "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
], - "links": {
- "self": "/api/v2/notificationEndpoints/1",
- "labels": "/api/v2/notificationEndpoints/1/labels",
- "members": "/api/v2/notificationEndpoints/1/members",
- "owners": "/api/v2/notificationEndpoints/1/owners"
}, - "type": "slack",
- "url": "string",
- "token": "string"
}| endpointID required | string The notification endpoint ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
A new notification endpoint to replace the existing endpoint with
| id | string |
| orgID | string |
| userID | string |
| description | string An optional description of the notification endpoint. |
| name required | string |
| status | string Default: "active" Enum: "active" "inactive" The status of the endpoint. |
Array of objects (Labels) | |
| type required | string (NotificationEndpointType) slack PostNotificationEndpoint NotificationEndpoint slack pagerduty http telegram |
| url | string Specifies the URL of the Slack endpoint. Specify either |
| token | string Specifies the API token string. Specify either |
{- "id": "string",
- "orgID": "string",
- "userID": "string",
- "description": "string",
- "name": "string",
- "status": "active",
- "labels": [
- {
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
], - "type": "slack",
- "url": "string",
- "token": "string"
}{- "id": "string",
- "orgID": "string",
- "userID": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "description": "string",
- "name": "string",
- "status": "active",
- "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
], - "links": {
- "self": "/api/v2/notificationEndpoints/1",
- "labels": "/api/v2/notificationEndpoints/1/labels",
- "members": "/api/v2/notificationEndpoints/1/members",
- "owners": "/api/v2/notificationEndpoints/1/owners"
}, - "type": "slack",
- "url": "string",
- "token": "string"
}| endpointID required | string The notification endpoint ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Check update to apply
| name | string |
| description | string |
| status | string Enum: "active" "inactive" |
{- "name": "string",
- "description": "string",
- "status": "active"
}{- "id": "string",
- "orgID": "string",
- "userID": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "description": "string",
- "name": "string",
- "status": "active",
- "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
], - "links": {
- "self": "/api/v2/notificationEndpoints/1",
- "labels": "/api/v2/notificationEndpoints/1/labels",
- "members": "/api/v2/notificationEndpoints/1/members",
- "owners": "/api/v2/notificationEndpoints/1/owners"
}, - "type": "slack",
- "url": "string",
- "token": "string"
}| endpointID required | string The notification endpoint ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| endpointID required | string The notification endpoint ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
],
}| endpointID required | string The notification endpoint ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Label to add
| labelID | string |
{- "labelID": "string"
}{- "label": {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
},
}| endpointID required | string The notification endpoint ID. |
| labelID required | string The ID of the label to delete. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| offset | integer >= 0 |
| limit | integer [ 1 .. 100 ] Default: 20 |
| orgID required | string Only show notification rules that belong to a specific organization ID. |
| checkID | string Only show notifications that belong to the specific check ID. |
| tag | string^[a-zA-Z0-9_]+:[a-zA-Z0-9_]+$ Example: tag=env:prod Only return notification rules that "would match" statuses which contain the tag key value pairs provided. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "notificationRules": [
- {
- "latestCompleted": "2019-08-24T14:15:22Z",
- "lastRunStatus": "failed",
- "lastRunError": "string",
- "id": "string",
- "endpointID": "string",
- "orgID": "string",
- "taskID": "string",
- "ownerID": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "status": "active",
- "name": "string",
- "sleepUntil": "string",
- "every": "string",
- "offset": "string",
- "runbookLink": "string",
- "limitEvery": 0,
- "limit": 0,
- "tagRules": [
- {
- "key": "string",
- "value": "string",
- "operator": "equal"
}
], - "description": "string",
- "statusRules": [
- {
- "currentLevel": "UNKNOWN",
- "previousLevel": "UNKNOWN",
- "count": 0,
- "period": "string"
}
], - "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
], - "links": {
- "self": "/api/v2/notificationRules/1",
- "labels": "/api/v2/notificationRules/1/labels",
- "members": "/api/v2/notificationRules/1/members",
- "owners": "/api/v2/notificationRules/1/owners",
- "query": "/api/v2/notificationRules/1/query"
}, - "type": "slack",
- "channel": "string",
- "messageTemplate": "string"
}
],
}Notification rule to create
| endpointID required | string |
| orgID required | string The ID of the organization that owns this notification rule. |
| taskID | string The ID of the task associated with this notification rule. |
| status required | string (TaskStatusType) Enum: "active" "inactive" |
| name required | string Human-readable name describing the notification rule. |
| sleepUntil | string |
| every | string The notification repetition interval. |
| offset | string Duration to delay after the schedule, before executing check. |
| runbookLink | string |
| limitEvery | integer Don't notify me more than |
| limit | integer Don't notify me more than |
Array of objects (TagRule) List of tag rules the notification rule attempts to match. | |
| description | string An optional description of the notification rule. |
required | Array of objects (StatusRule) non-empty List of status rules the notification rule attempts to match. |
Array of objects (Labels) | |
| type required | string slack PostNotificationRule NotificationRule telegram http pagerduty smtp slack |
| channel | string |
| messageTemplate required | string |
{- "endpointID": "string",
- "orgID": "string",
- "taskID": "string",
- "status": "active",
- "name": "string",
- "sleepUntil": "string",
- "every": "string",
- "offset": "string",
- "runbookLink": "string",
- "limitEvery": 0,
- "limit": 0,
- "tagRules": [
- {
- "key": "string",
- "value": "string",
- "operator": "equal"
}
], - "description": "string",
- "statusRules": [
- {
- "currentLevel": "UNKNOWN",
- "previousLevel": "UNKNOWN",
- "count": 0,
- "period": "string"
}
], - "labels": [
- {
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
], - "type": "slack",
- "channel": "string",
- "messageTemplate": "string"
}{- "latestCompleted": "2019-08-24T14:15:22Z",
- "lastRunStatus": "failed",
- "lastRunError": "string",
- "id": "string",
- "endpointID": "string",
- "orgID": "string",
- "taskID": "string",
- "ownerID": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "status": "active",
- "name": "string",
- "sleepUntil": "string",
- "every": "string",
- "offset": "string",
- "runbookLink": "string",
- "limitEvery": 0,
- "limit": 0,
- "tagRules": [
- {
- "key": "string",
- "value": "string",
- "operator": "equal"
}
], - "description": "string",
- "statusRules": [
- {
- "currentLevel": "UNKNOWN",
- "previousLevel": "UNKNOWN",
- "count": 0,
- "period": "string"
}
], - "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
], - "links": {
- "self": "/api/v2/notificationRules/1",
- "labels": "/api/v2/notificationRules/1/labels",
- "members": "/api/v2/notificationRules/1/members",
- "owners": "/api/v2/notificationRules/1/owners",
- "query": "/api/v2/notificationRules/1/query"
}, - "type": "slack",
- "channel": "string",
- "messageTemplate": "string"
}| ruleID required | string The notification rule ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "latestCompleted": "2019-08-24T14:15:22Z",
- "lastRunStatus": "failed",
- "lastRunError": "string",
- "id": "string",
- "endpointID": "string",
- "orgID": "string",
- "taskID": "string",
- "ownerID": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "status": "active",
- "name": "string",
- "sleepUntil": "string",
- "every": "string",
- "offset": "string",
- "runbookLink": "string",
- "limitEvery": 0,
- "limit": 0,
- "tagRules": [
- {
- "key": "string",
- "value": "string",
- "operator": "equal"
}
], - "description": "string",
- "statusRules": [
- {
- "currentLevel": "UNKNOWN",
- "previousLevel": "UNKNOWN",
- "count": 0,
- "period": "string"
}
], - "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
], - "links": {
- "self": "/api/v2/notificationRules/1",
- "labels": "/api/v2/notificationRules/1/labels",
- "members": "/api/v2/notificationRules/1/members",
- "owners": "/api/v2/notificationRules/1/owners",
- "query": "/api/v2/notificationRules/1/query"
}, - "type": "slack",
- "channel": "string",
- "messageTemplate": "string"
}| ruleID required | string The notification rule ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Notification rule update to apply
| endpointID required | string |
| orgID required | string The ID of the organization that owns this notification rule. |
| taskID | string The ID of the task associated with this notification rule. |
| status required | string (TaskStatusType) Enum: "active" "inactive" |
| name required | string Human-readable name describing the notification rule. |
| sleepUntil | string |
| every | string The notification repetition interval. |
| offset | string Duration to delay after the schedule, before executing check. |
| runbookLink | string |
| limitEvery | integer Don't notify me more than |
| limit | integer Don't notify me more than |
Array of objects (TagRule) List of tag rules the notification rule attempts to match. | |
| description | string An optional description of the notification rule. |
required | Array of objects (StatusRule) non-empty List of status rules the notification rule attempts to match. |
Array of objects (Labels) | |
| type required | string slack PostNotificationRule NotificationRule telegram http pagerduty smtp slack |
| channel | string |
| messageTemplate required | string |
{- "endpointID": "string",
- "orgID": "string",
- "taskID": "string",
- "status": "active",
- "name": "string",
- "sleepUntil": "string",
- "every": "string",
- "offset": "string",
- "runbookLink": "string",
- "limitEvery": 0,
- "limit": 0,
- "tagRules": [
- {
- "key": "string",
- "value": "string",
- "operator": "equal"
}
], - "description": "string",
- "statusRules": [
- {
- "currentLevel": "UNKNOWN",
- "previousLevel": "UNKNOWN",
- "count": 0,
- "period": "string"
}
], - "labels": [
- {
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
], - "type": "slack",
- "channel": "string",
- "messageTemplate": "string"
}{- "latestCompleted": "2019-08-24T14:15:22Z",
- "lastRunStatus": "failed",
- "lastRunError": "string",
- "id": "string",
- "endpointID": "string",
- "orgID": "string",
- "taskID": "string",
- "ownerID": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "status": "active",
- "name": "string",
- "sleepUntil": "string",
- "every": "string",
- "offset": "string",
- "runbookLink": "string",
- "limitEvery": 0,
- "limit": 0,
- "tagRules": [
- {
- "key": "string",
- "value": "string",
- "operator": "equal"
}
], - "description": "string",
- "statusRules": [
- {
- "currentLevel": "UNKNOWN",
- "previousLevel": "UNKNOWN",
- "count": 0,
- "period": "string"
}
], - "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
], - "links": {
- "self": "/api/v2/notificationRules/1",
- "labels": "/api/v2/notificationRules/1/labels",
- "members": "/api/v2/notificationRules/1/members",
- "owners": "/api/v2/notificationRules/1/owners",
- "query": "/api/v2/notificationRules/1/query"
}, - "type": "slack",
- "channel": "string",
- "messageTemplate": "string"
}| ruleID required | string The notification rule ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Notification rule update to apply
| name | string |
| description | string |
| status | string Enum: "active" "inactive" |
{- "name": "string",
- "description": "string",
- "status": "active"
}{- "latestCompleted": "2019-08-24T14:15:22Z",
- "lastRunStatus": "failed",
- "lastRunError": "string",
- "id": "string",
- "endpointID": "string",
- "orgID": "string",
- "taskID": "string",
- "ownerID": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "status": "active",
- "name": "string",
- "sleepUntil": "string",
- "every": "string",
- "offset": "string",
- "runbookLink": "string",
- "limitEvery": 0,
- "limit": 0,
- "tagRules": [
- {
- "key": "string",
- "value": "string",
- "operator": "equal"
}
], - "description": "string",
- "statusRules": [
- {
- "currentLevel": "UNKNOWN",
- "previousLevel": "UNKNOWN",
- "count": 0,
- "period": "string"
}
], - "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
], - "links": {
- "self": "/api/v2/notificationRules/1",
- "labels": "/api/v2/notificationRules/1/labels",
- "members": "/api/v2/notificationRules/1/members",
- "owners": "/api/v2/notificationRules/1/owners",
- "query": "/api/v2/notificationRules/1/query"
}, - "type": "slack",
- "channel": "string",
- "messageTemplate": "string"
}| ruleID required | string The notification rule ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| ruleID required | string The notification rule ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
],
}| ruleID required | string The notification rule ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Label to add
| labelID | string |
{- "labelID": "string"
}{- "label": {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
},
}| ruleID required | string The notification rule ID. |
| labelID required | string The ID of the label to delete. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| offset | integer >= 0 |
| limit | integer [ 1 .. 100 ] Default: 20 |
| descending | boolean Default: false |
| org | string Filter organizations to a specific organization name. |
| orgID | string Filter organizations to a specific organization ID. |
| userID | string Filter organizations to a specific user ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "orgs": [
- {
- "links": {
- "self": "/api/v2/orgs/1",
- "members": "/api/v2/orgs/1/members",
- "owners": "/api/v2/orgs/1/owners",
- "labels": "/api/v2/orgs/1/labels",
- "secrets": "/api/v2/orgs/1/secrets",
- "buckets": "/api/v2/buckets?org=myorg",
- "tasks": "/api/v2/tasks?org=myorg",
- "dashboards": "/api/v2/dashboards?org=myorg"
}, - "id": "string",
- "name": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "status": "active"
}
]
}| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Organization to create
| name required | string |
| description | string |
{- "name": "string",
- "description": "string"
}{- "links": {
- "self": "/api/v2/orgs/1",
- "members": "/api/v2/orgs/1/members",
- "owners": "/api/v2/orgs/1/owners",
- "labels": "/api/v2/orgs/1/labels",
- "secrets": "/api/v2/orgs/1/secrets",
- "buckets": "/api/v2/buckets?org=myorg",
- "tasks": "/api/v2/tasks?org=myorg",
- "dashboards": "/api/v2/dashboards?org=myorg"
}, - "id": "string",
- "name": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "status": "active"
}| orgID required | string The ID of the organization to get. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "links": {
- "self": "/api/v2/orgs/1",
- "members": "/api/v2/orgs/1/members",
- "owners": "/api/v2/orgs/1/owners",
- "labels": "/api/v2/orgs/1/labels",
- "secrets": "/api/v2/orgs/1/secrets",
- "buckets": "/api/v2/buckets?org=myorg",
- "tasks": "/api/v2/tasks?org=myorg",
- "dashboards": "/api/v2/dashboards?org=myorg"
}, - "id": "string",
- "name": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "status": "active"
}| orgID required | string The ID of the organization to get. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Organization update to apply
| name | string New name to set on the organization |
| description | string New description to set on the organization |
{- "name": "string",
- "description": "string"
}{- "links": {
- "self": "/api/v2/orgs/1",
- "members": "/api/v2/orgs/1/members",
- "owners": "/api/v2/orgs/1/owners",
- "labels": "/api/v2/orgs/1/labels",
- "secrets": "/api/v2/orgs/1/secrets",
- "buckets": "/api/v2/buckets?org=myorg",
- "tasks": "/api/v2/tasks?org=myorg",
- "dashboards": "/api/v2/dashboards?org=myorg"
}, - "id": "string",
- "name": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "status": "active"
}| orgID required | string The ID of the organization to delete. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| orgID required | string The organization ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "users": [
- {
- "id": "string",
- "oauthID": "string",
- "name": "string",
- "status": "active",
- "links": {
- "self": "/api/v2/users/1"
}, - "role": "member"
}
]
}| orgID required | string The organization ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
User to add as member
| id required | string |
| name | string |
{- "id": "string",
- "name": "string"
}{- "id": "string",
- "oauthID": "string",
- "name": "string",
- "status": "active",
- "links": {
- "self": "/api/v2/users/1"
}, - "role": "member"
}| userID required | string The ID of the member to remove. |
| orgID required | string The organization ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| orgID required | string The organization ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "users": [
- {
- "id": "string",
- "oauthID": "string",
- "name": "string",
- "status": "active",
- "links": {
- "self": "/api/v2/users/1"
}, - "role": "owner"
}
]
}| orgID required | string The organization ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
User to add as owner
| id required | string |
| name | string |
{- "id": "string",
- "name": "string"
}{- "id": "string",
- "oauthID": "string",
- "name": "string",
- "status": "active",
- "links": {
- "self": "/api/v2/users/1"
}, - "role": "owner"
}| userID required | string The ID of the owner to remove. |
| orgID required | string The organization ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}Analyzes flux query and generates a query specification.
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
| Content-Type | string Value: "application/json" |
Analyzed Flux query to generate abstract syntax tree.
| query required | string Flux query script to be analyzed |
{- "query": "string"
}{- "ast": {
- "type": "string",
- "path": "string",
- "package": "string",
- "files": [
- {
- "type": "string",
- "name": "string",
- "package": {
- "type": "string",
- "name": {
- "type": "string",
- "name": "string"
}
}, - "imports": [
- {
- "type": "string",
- "as": {
- "type": "string",
- "name": "string"
}, - "path": {
- "type": "string",
- "value": "string"
}
}
], - "body": [
- {
- "type": "string",
- "text": "string"
}
]
}
]
}
}| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "funcs": [
- {
- "name": "string",
- "params": {
- "property1": "string",
- "property2": "string"
}
}
]
}| name required | string The name of the branching suggestion. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "name": "string",
- "params": {
- "property1": "string",
- "property2": "string"
}
}| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
| Content-Type | string Value: "application/json" |
Flux or InfluxQL query to analyze
object (File) Represents a source from a single file | |
| query required | string Query script to execute. |
| type | string Value: "flux" The type of query. Must be "flux". |
object Enumeration of key-value pairs that respresent parameters to be injected into query (can only specify either this field or extern and not both) | |
object (Dialect) Dialect are options to change the default CSV output format; https://www.w3.org/TR/2015/REC-tabular-metadata-20151217/#dialect-descriptions | |
| now | string <date-time> Specifies the time that should be reported as "now" in the query. Default is the server's now time. |
{- "extern": {
- "type": "string",
- "name": "string",
- "package": {
- "type": "string",
- "name": {
- "type": "string",
- "name": "string"
}
}, - "imports": [
- {
- "type": "string",
- "as": {
- "type": "string",
- "name": "string"
}, - "path": {
- "type": "string",
- "value": "string"
}
}
], - "body": [
- {
- "type": "string",
- "text": "string"
}
]
}, - "query": "string",
- "type": "flux",
- "params": { },
- "dialect": {
- "header": true,
- "delimiter": ",",
- "annotations": [
- "group"
], - "commentPrefix": "#",
- "dateTimeFormat": "RFC3339"
}, - "now": "2019-08-24T14:15:22Z"
}{- "errors": [
- {
- "line": 0,
- "column": 0,
- "character": 0,
- "message": "string"
}
]
}Retrieves data from InfluxDB buckets.
To query data, you need the following:
For more information and examples, see Query with the InfluxDB API.
| org | string Specifies the name of the organization executing the query. Takes either the ID or Name. If both |
| orgID | string Specifies the ID of the organization executing the query. If both |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
| Accept-Encoding | string Default: identity Enum: "gzip" "identity" The Accept-Encoding request HTTP header advertises which content encoding, usually a compression algorithm, the client is able to understand. |
| Content-Type | string Enum: "application/json" "application/vnd.flux" |
Flux query or specification to execute
object (File) Represents a source from a single file | |
| query required | string Query script to execute. |
| type | string Value: "flux" The type of query. Must be "flux". |
object Enumeration of key-value pairs that respresent parameters to be injected into query (can only specify either this field or extern and not both) | |
object (Dialect) Dialect are options to change the default CSV output format; https://www.w3.org/TR/2015/REC-tabular-metadata-20151217/#dialect-descriptions | |
| now | string <date-time> Specifies the time that should be reported as "now" in the query. Default is the server's now time. |
{- "extern": {
- "type": "string",
- "name": "string",
- "package": {
- "type": "string",
- "name": {
- "type": "string",
- "name": "string"
}
}, - "imports": [
- {
- "type": "string",
- "as": {
- "type": "string",
- "name": "string"
}, - "path": {
- "type": "string",
- "value": "string"
}
}
], - "body": [
- {
- "type": "string",
- "text": "string"
}
]
}, - "query": "string",
- "type": "flux",
- "params": { },
- "dialect": {
- "header": true,
- "delimiter": ",",
- "annotations": [
- "group"
], - "commentPrefix": "#",
- "dateTimeFormat": "RFC3339"
}, - "now": "2019-08-24T14:15:22Z"
}{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| ruleID required | string The notification rule ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "flux": "string"
}| orgID required | string The organization ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "secrets": [
- "string"
], - "links": {
- "self": "string",
- "org": "string"
}
}| orgID required | string The organization ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Secret key value pairs to update/add
| property name* | string |
{- "apikey": "abc123xyz"
}{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| orgID required | string The organization ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Secret key to delete
| secrets | Array of strings |
{- "secrets": [
- "string"
]
}{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| orgID required | string The organization ID. |
| secretID required | string The secret ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}Check if setup is allowed. Returns true if no default user, organization, or bucket have been created.
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "allowed": true
}Post an onboarding request to create an initial user, organization, and bucket.
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Source to create
| username required | string |
| password | string |
| org required | string |
| bucket required | string |
| retentionPeriodHrs | integer Deprecated |
| retentionPeriodSeconds | integer |
object (Limit) These are org limits similar to those configured in/by quartz. |
{- "username": "string",
- "password": "string",
- "org": "string",
- "bucket": "string",
- "retentionPeriodHrs": 0,
- "retentionPeriodSeconds": 0,
- "limit": {
- "orgID": "string",
- "rate": {
- "readKBs": 0,
- "concurrentReadRequests": 0,
- "writeKBs": 0,
- "concurrentWriteRequests": 0,
- "cardinality": 0,
- "concurrentDeleteRequests": 0,
- "deleteRequestsPerSecond": 0
}, - "bucket": {
- "maxBuckets": 0,
- "maxRetentionDuration": 0
}, - "task": {
- "maxTasks": 0
}, - "dashboard": {
- "maxDashboards": 0
}, - "check": {
- "maxChecks": 0
}, - "notificationRule": {
- "maxNotifications": 0,
- "blockedNotificationRules": "http,pagerduty"
}, - "notificationEndpoint": {
- "blockedNotificationEndpoints": "http,pagerduty"
}, - "features": {
- "allowDelete": true
}
}
}{- "user": {
- "id": "string",
- "oauthID": "string",
- "name": "string",
- "status": "active",
- "links": {
- "self": "/api/v2/users/1"
}
}, - "org": {
- "links": {
- "self": "/api/v2/orgs/1",
- "members": "/api/v2/orgs/1/members",
- "owners": "/api/v2/orgs/1/owners",
- "labels": "/api/v2/orgs/1/labels",
- "secrets": "/api/v2/orgs/1/secrets",
- "buckets": "/api/v2/buckets?org=myorg",
- "tasks": "/api/v2/tasks?org=myorg",
- "dashboards": "/api/v2/dashboards?org=myorg"
}, - "id": "string",
- "name": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "status": "active"
}, - "bucket": {
- "links": {
- "labels": "/api/v2/buckets/1/labels",
- "members": "/api/v2/buckets/1/members",
- "org": "/api/v2/orgs/2",
- "owners": "/api/v2/buckets/1/owners",
- "self": "/api/v2/buckets/1",
- "write": "/api/v2/write?org=2&bucket=1"
}, - "id": "string",
- "type": "user",
- "name": "string",
- "description": "string",
- "orgID": "string",
- "rp": "string",
- "schemaType": "implicit",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "retentionRules": [
- {
- "type": "expire",
- "everySeconds": 86400,
- "shardGroupDurationSeconds": 0
}
], - "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
]
}, - "auth": {
- "status": "active",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "orgID": "string",
- "permissions": [
- {
- "action": "read",
- "resource": {
- "type": "authorizations",
- "id": "string",
- "name": "string",
- "orgID": "string",
- "org": "string"
}
}
], - "id": "string",
- "token": "string",
- "userID": "string",
- "user": "string",
- "org": "string",
- "links": {
- "self": "/api/v2/authorizations/1",
- "user": "/api/v2/users/12"
}
}
}Post an onboarding request to create a new user, organization, and bucket.
Source to create
| username required | string |
| password | string |
| org required | string |
| bucket required | string |
| retentionPeriodHrs | integer Deprecated |
| retentionPeriodSeconds | integer |
object (Limit) These are org limits similar to those configured in/by quartz. |
{- "username": "string",
- "password": "string",
- "org": "string",
- "bucket": "string",
- "retentionPeriodHrs": 0,
- "retentionPeriodSeconds": 0,
- "limit": {
- "orgID": "string",
- "rate": {
- "readKBs": 0,
- "concurrentReadRequests": 0,
- "writeKBs": 0,
- "concurrentWriteRequests": 0,
- "cardinality": 0,
- "concurrentDeleteRequests": 0,
- "deleteRequestsPerSecond": 0
}, - "bucket": {
- "maxBuckets": 0,
- "maxRetentionDuration": 0
}, - "task": {
- "maxTasks": 0
}, - "dashboard": {
- "maxDashboards": 0
}, - "check": {
- "maxChecks": 0
}, - "notificationRule": {
- "maxNotifications": 0,
- "blockedNotificationRules": "http,pagerduty"
}, - "notificationEndpoint": {
- "blockedNotificationEndpoints": "http,pagerduty"
}, - "features": {
- "allowDelete": true
}
}
}{- "user": {
- "id": "string",
- "oauthID": "string",
- "name": "string",
- "status": "active",
- "links": {
- "self": "/api/v2/users/1"
}
}, - "org": {
- "links": {
- "self": "/api/v2/orgs/1",
- "members": "/api/v2/orgs/1/members",
- "owners": "/api/v2/orgs/1/owners",
- "labels": "/api/v2/orgs/1/labels",
- "secrets": "/api/v2/orgs/1/secrets",
- "buckets": "/api/v2/buckets?org=myorg",
- "tasks": "/api/v2/tasks?org=myorg",
- "dashboards": "/api/v2/dashboards?org=myorg"
}, - "id": "string",
- "name": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "status": "active"
}, - "bucket": {
- "links": {
- "labels": "/api/v2/buckets/1/labels",
- "members": "/api/v2/buckets/1/members",
- "org": "/api/v2/orgs/2",
- "owners": "/api/v2/buckets/1/owners",
- "self": "/api/v2/buckets/1",
- "write": "/api/v2/write?org=2&bucket=1"
}, - "id": "string",
- "type": "user",
- "name": "string",
- "description": "string",
- "orgID": "string",
- "rp": "string",
- "schemaType": "implicit",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "retentionRules": [
- {
- "type": "expire",
- "everySeconds": 86400,
- "shardGroupDurationSeconds": 0
}
], - "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
]
}, - "auth": {
- "status": "active",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "orgID": "string",
- "permissions": [
- {
- "action": "read",
- "resource": {
- "type": "authorizations",
- "id": "string",
- "name": "string",
- "orgID": "string",
- "org": "string"
}
}
], - "id": "string",
- "token": "string",
- "userID": "string",
- "user": "string",
- "org": "string",
- "links": {
- "self": "/api/v2/authorizations/1",
- "user": "/api/v2/users/12"
}
}
}Authenticates Basic Auth credentials for a user. If successful, creates a new UI session for the user.
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}Expires the current UI session for the user.
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| taskID required | string The task ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "id": "string",
- "type": "string",
- "orgID": "string",
- "org": "string",
- "name": "string",
- "ownerID": "string",
- "description": "string",
- "status": "active",
- "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
], - "authorizationID": "string",
- "flux": "string",
- "every": "string",
- "cron": "string",
- "offset": "string",
- "latestCompleted": "2019-08-24T14:15:22Z",
- "lastRunStatus": "failed",
- "lastRunError": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "links": {
- "self": "/api/v2/tasks/1",
- "owners": "/api/v2/tasks/1/owners",
- "members": "/api/v2/tasks/1/members",
- "labels": "/api/v2/tasks/1/labels",
- "runs": "/api/v2/tasks/1/runs",
- "logs": "/api/v2/tasks/1/logs"
}
}Update a task. This will cancel all queued runs.
| taskID required | string The task ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Task update to apply
| status | string (TaskStatusType) Enum: "active" "inactive" |
| flux | string The Flux script to run for this task. |
| name | string Override the 'name' option in the flux script. |
| every | string Override the 'every' option in the flux script. |
| cron | string Override the 'cron' option in the flux script. |
| offset | string Override the 'offset' option in the flux script. |
| description | string An optional description of the task. |
{- "status": "active",
- "flux": "string",
- "name": "string",
- "every": "string",
- "cron": "string",
- "offset": "string",
- "description": "string"
}{- "id": "string",
- "type": "string",
- "orgID": "string",
- "org": "string",
- "name": "string",
- "ownerID": "string",
- "description": "string",
- "status": "active",
- "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
], - "authorizationID": "string",
- "flux": "string",
- "every": "string",
- "cron": "string",
- "offset": "string",
- "latestCompleted": "2019-08-24T14:15:22Z",
- "lastRunStatus": "failed",
- "lastRunError": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "links": {
- "self": "/api/v2/tasks/1",
- "owners": "/api/v2/tasks/1/owners",
- "members": "/api/v2/tasks/1/members",
- "labels": "/api/v2/tasks/1/labels",
- "runs": "/api/v2/tasks/1/runs",
- "logs": "/api/v2/tasks/1/logs"
}
}Deletes a task and all associated records
| taskID required | string The ID of the task to delete. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| taskID required | string The ID of the task to get runs for. |
| after | string Returns runs after a specific ID. |
| limit | integer [ 1 .. 500 ] Default: 100 The number of runs to return |
| afterTime | string <date-time> Filter runs to those scheduled after this time, RFC3339 |
| beforeTime | string <date-time> Filter runs to those scheduled before this time, RFC3339 |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "runs": [
- {
- "id": "string",
- "taskID": "string",
- "status": "scheduled",
- "scheduledFor": "2019-08-24T14:15:22Z",
- "log": [
- {
- "time": "2019-08-24T14:15:22Z",
- "message": "Halt and catch fire",
- "runID": "string"
}
], - "startedAt": "2019-08-24T14:15:22Z",
- "finishedAt": "2019-08-24T14:15:22Z",
- "requestedAt": "2019-08-24T14:15:22Z",
- "links": {
- "self": "/api/v2/tasks/1/runs/1",
- "task": "/api/v2/tasks/1",
- "retry": "/api/v2/tasks/1/runs/1/retry"
}
}
]
}| taskID required | string |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
| scheduledFor | string <date-time> Nullable Time used for run's "now" option, RFC3339. Default is the server's now time. |
{- "scheduledFor": "2019-08-24T14:15:22Z"
}{- "id": "string",
- "taskID": "string",
- "status": "scheduled",
- "scheduledFor": "2019-08-24T14:15:22Z",
- "log": [
- {
- "time": "2019-08-24T14:15:22Z",
- "message": "Halt and catch fire",
- "runID": "string"
}
], - "startedAt": "2019-08-24T14:15:22Z",
- "finishedAt": "2019-08-24T14:15:22Z",
- "requestedAt": "2019-08-24T14:15:22Z",
- "links": {
- "self": "/api/v2/tasks/1/runs/1",
- "task": "/api/v2/tasks/1",
- "retry": "/api/v2/tasks/1/runs/1/retry"
}
}| taskID required | string The task ID. |
| runID required | string The run ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "id": "string",
- "taskID": "string",
- "status": "scheduled",
- "scheduledFor": "2019-08-24T14:15:22Z",
- "log": [
- {
- "time": "2019-08-24T14:15:22Z",
- "message": "Halt and catch fire",
- "runID": "string"
}
], - "startedAt": "2019-08-24T14:15:22Z",
- "finishedAt": "2019-08-24T14:15:22Z",
- "requestedAt": "2019-08-24T14:15:22Z",
- "links": {
- "self": "/api/v2/tasks/1/runs/1",
- "task": "/api/v2/tasks/1",
- "retry": "/api/v2/tasks/1/runs/1/retry"
}
}| taskID required | string The task ID. |
| runID required | string The run ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| taskID required | string The task ID. |
| runID required | string The run ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{ }{- "id": "string",
- "taskID": "string",
- "status": "scheduled",
- "scheduledFor": "2019-08-24T14:15:22Z",
- "log": [
- {
- "time": "2019-08-24T14:15:22Z",
- "message": "Halt and catch fire",
- "runID": "string"
}
], - "startedAt": "2019-08-24T14:15:22Z",
- "finishedAt": "2019-08-24T14:15:22Z",
- "requestedAt": "2019-08-24T14:15:22Z",
- "links": {
- "self": "/api/v2/tasks/1/runs/1",
- "task": "/api/v2/tasks/1",
- "retry": "/api/v2/tasks/1/runs/1/retry"
}
}| taskID required | string The task ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "events": [
- {
- "time": "2019-08-24T14:15:22Z",
- "message": "Halt and catch fire",
- "runID": "string"
}
]
}| taskID required | string ID of task to get logs for. |
| runID required | string ID of run to get logs for. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "events": [
- {
- "time": "2019-08-24T14:15:22Z",
- "message": "Halt and catch fire",
- "runID": "string"
}
]
}| taskID required | string The task ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
],
}| taskID required | string The task ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Label to add
| labelID | string |
{- "labelID": "string"
}{- "label": {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
},
}| taskID required | string The task ID. |
| labelID required | string The label ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| taskID required | string The task ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "users": [
- {
- "id": "string",
- "oauthID": "string",
- "name": "string",
- "status": "active",
- "links": {
- "self": "/api/v2/users/1"
}, - "role": "member"
}
]
}| taskID required | string The task ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
User to add as member
| id required | string |
| name | string |
{- "id": "string",
- "name": "string"
}{- "id": "string",
- "oauthID": "string",
- "name": "string",
- "status": "active",
- "links": {
- "self": "/api/v2/users/1"
}, - "role": "member"
}| userID required | string The ID of the member to remove. |
| taskID required | string The task ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| taskID required | string The task ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "users": [
- {
- "id": "string",
- "oauthID": "string",
- "name": "string",
- "status": "active",
- "links": {
- "self": "/api/v2/users/1"
}, - "role": "owner"
}
]
}| taskID required | string The task ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
User to add as owner
| id required | string |
| name | string |
{- "id": "string",
- "name": "string"
}{- "id": "string",
- "oauthID": "string",
- "name": "string",
- "status": "active",
- "links": {
- "self": "/api/v2/users/1"
}, - "role": "owner"
}| userID required | string The ID of the owner to remove. |
| taskID required | string The task ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| name | string Returns task with a specific name. |
| after | string Return tasks after a specified ID. |
| user | string Filter tasks to a specific user ID. |
| org | string Filter tasks to a specific organization name. |
| orgID | string Filter tasks to a specific organization ID. |
| status | string Enum: "active" "inactive" Filter tasks by a status--"inactive" or "active". |
| limit | integer [ -1 .. 500 ] Default: 100 The non-zero number of tasks to return |
| type | string Default: "" Enum: "basic" "system" Type of task, unset by default. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "tasks": [
- {
- "id": "string",
- "type": "string",
- "orgID": "string",
- "org": "string",
- "name": "string",
- "ownerID": "string",
- "description": "string",
- "status": "active",
- "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
], - "authorizationID": "string",
- "flux": "string",
- "every": "string",
- "cron": "string",
- "offset": "string",
- "latestCompleted": "2019-08-24T14:15:22Z",
- "lastRunStatus": "failed",
- "lastRunError": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "links": {
- "self": "/api/v2/tasks/1",
- "owners": "/api/v2/tasks/1/owners",
- "members": "/api/v2/tasks/1/members",
- "labels": "/api/v2/tasks/1/labels",
- "runs": "/api/v2/tasks/1/runs",
- "logs": "/api/v2/tasks/1/logs"
}
}
]
}| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Task to create
| orgID | string The ID of the organization that owns this Task. |
| org | string The name of the organization that owns this Task. |
| status | string (TaskStatusType) Enum: "active" "inactive" |
| flux required | string The Flux script to run for this task. |
| description | string An optional description of the task. |
{- "orgID": "string",
- "org": "string",
- "status": "active",
- "flux": "string",
- "description": "string"
}{- "id": "string",
- "type": "string",
- "orgID": "string",
- "org": "string",
- "name": "string",
- "ownerID": "string",
- "description": "string",
- "status": "active",
- "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
], - "authorizationID": "string",
- "flux": "string",
- "every": "string",
- "cron": "string",
- "offset": "string",
- "latestCompleted": "2019-08-24T14:15:22Z",
- "lastRunStatus": "failed",
- "lastRunError": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "links": {
- "self": "/api/v2/tasks/1",
- "owners": "/api/v2/tasks/1/owners",
- "members": "/api/v2/tasks/1/members",
- "labels": "/api/v2/tasks/1/labels",
- "runs": "/api/v2/tasks/1/runs",
- "logs": "/api/v2/tasks/1/logs"
}
}| orgID | string The organization ID the Telegraf config belongs to. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "configurations": [
- {
- "name": "string",
- "description": "string",
- "metadata": {
- "buckets": [
- "string"
]
}, - "config": "string",
- "orgID": "string",
- "id": "string",
- "links": {
- "self": "/api/v2/telegrafs/1",
- "lables": "/api/v2/telegrafs/1/labels",
- "owners": "/api/v2/telegrafs/1/owners",
- "members": "/api/v2/telegrafs/1/members"
}, - "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
]
}
]
}| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Telegraf configuration to create
| name | string |
| description | string |
object | |
| config | string |
| orgID | string |
{- "name": "string",
- "description": "string",
- "metadata": {
- "buckets": [
- "string"
]
}, - "config": "string",
- "orgID": "string"
}{- "name": "string",
- "description": "string",
- "metadata": {
- "buckets": [
- "string"
]
}, - "config": "string",
- "orgID": "string",
- "id": "string",
- "links": {
- "self": "/api/v2/telegrafs/1",
- "lables": "/api/v2/telegrafs/1/labels",
- "owners": "/api/v2/telegrafs/1/owners",
- "members": "/api/v2/telegrafs/1/members"
}, - "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
]
}| telegrafID required | string The Telegraf configuration ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
| Accept | string Default: application/toml Enum: "application/toml" "application/json" "application/octet-stream" |
[agent] interval = "10s"
| telegrafID required | string The Telegraf config ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Telegraf configuration update to apply
| name | string |
| description | string |
object | |
| config | string |
| orgID | string |
{- "name": "string",
- "description": "string",
- "metadata": {
- "buckets": [
- "string"
]
}, - "config": "string",
- "orgID": "string"
}{- "name": "string",
- "description": "string",
- "metadata": {
- "buckets": [
- "string"
]
}, - "config": "string",
- "orgID": "string",
- "id": "string",
- "links": {
- "self": "/api/v2/telegrafs/1",
- "lables": "/api/v2/telegrafs/1/labels",
- "owners": "/api/v2/telegrafs/1/owners",
- "members": "/api/v2/telegrafs/1/members"
}, - "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
]
}| telegrafID required | string The Telegraf configuration ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| telegrafID required | string The Telegraf config ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
],
}| telegrafID required | string The Telegraf config ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Label to add
| labelID | string |
{- "labelID": "string"
}{- "label": {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
},
}| telegrafID required | string The Telegraf config ID. |
| labelID required | string The label ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| telegrafID required | string The Telegraf config ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "users": [
- {
- "id": "string",
- "oauthID": "string",
- "name": "string",
- "status": "active",
- "links": {
- "self": "/api/v2/users/1"
}, - "role": "member"
}
]
}| telegrafID required | string The Telegraf config ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
User to add as member
| id required | string |
| name | string |
{- "id": "string",
- "name": "string"
}{- "id": "string",
- "oauthID": "string",
- "name": "string",
- "status": "active",
- "links": {
- "self": "/api/v2/users/1"
}, - "role": "member"
}| userID required | string The ID of the member to remove. |
| telegrafID required | string The Telegraf config ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| telegrafID required | string The Telegraf configuration ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "users": [
- {
- "id": "string",
- "oauthID": "string",
- "name": "string",
- "status": "active",
- "links": {
- "self": "/api/v2/users/1"
}, - "role": "owner"
}
]
}| telegrafID required | string The Telegraf configuration ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
User to add as owner
| id required | string |
| name | string |
{- "id": "string",
- "name": "string"
}{- "id": "string",
- "oauthID": "string",
- "name": "string",
- "status": "active",
- "links": {
- "self": "/api/v2/users/1"
}, - "role": "owner"
}| userID required | string The ID of the owner to remove. |
| telegrafID required | string The Telegraf config ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| org | string Specifies the name of the organization of the template. |
| orgID | string Specifies the organization ID of the template. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "documents": [
- {
- "id": "string",
- "meta": {
- "name": "string",
- "type": "string",
- "templateID": "string",
- "description": "string",
- "version": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}, - "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
], - "links": {
- "self": "/api/v2/documents/templates/1"
}
}
]
}| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Template that will be created
required | object (DocumentMeta) |
| content required | object |
| org | string The organization Name. Specify either |
| orgID | string The organization Name. Specify either |
| labels | Array of strings An array of label IDs to be added as labels to the document. |
{- "meta": {
- "name": "string",
- "type": "string",
- "templateID": "string",
- "description": "string",
- "version": "string"
}, - "content": { },
- "org": "string",
- "orgID": "string",
- "labels": [
- "string"
]
}{- "id": "string",
- "meta": {
- "name": "string",
- "type": "string",
- "templateID": "string",
- "description": "string",
- "version": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}, - "content": { },
- "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
], - "links": {
- "self": "/api/v2/documents/templates/1"
}
}| templateID required | string The template ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "id": "string",
- "meta": {
- "name": "string",
- "type": "string",
- "templateID": "string",
- "description": "string",
- "version": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}, - "content": { },
- "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
], - "links": {
- "self": "/api/v2/documents/templates/1"
}
}| templateID required | string The template ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Template that will be updated
object (DocumentMeta) | |
| content | object |
{- "meta": {
- "name": "string",
- "type": "string",
- "templateID": "string",
- "description": "string",
- "version": "string"
}, - "content": { }
}{- "id": "string",
- "meta": {
- "name": "string",
- "type": "string",
- "templateID": "string",
- "description": "string",
- "version": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}, - "content": { },
- "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
], - "links": {
- "self": "/api/v2/documents/templates/1"
}
}| templateID required | string The template ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| templateID required | string The template ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
],
}| templateID required | string The template ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Label to add
| labelID | string |
{- "labelID": "string"
}{- "label": {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
},
}| templateID required | string The template ID. |
| labelID required | string The label ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| orgID required | string The organization ID of the stacks |
| name | string A collection of names to filter the list by. |
| stackID | string A collection of stackIDs to filter the list by. |
{- "stacks": [
- {
- "id": "string",
- "orgID": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "events": [
- {
- "eventType": "string",
- "name": "string",
- "description": "string",
- "sources": [
- "string"
], - "resources": [
- {
- "apiVersion": "string",
- "resourceID": "string",
- "kind": "Bucket",
- "templateMetaName": "string",
- "associations": [
- {
- "kind": "Bucket",
- "metaName": "string"
}
], - "links": {
- "self": "string"
}
}
], - "urls": [
- "string"
], - "updatedAt": "2019-08-24T14:15:22Z"
}
]
}
]
}The stack to create.
| orgID | string |
| name | string |
| description | string |
| urls | Array of strings |
{- "orgID": "string",
- "name": "string",
- "description": "string",
- "urls": [
- "string"
]
}{- "id": "string",
- "orgID": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "events": [
- {
- "eventType": "string",
- "name": "string",
- "description": "string",
- "sources": [
- "string"
], - "resources": [
- {
- "apiVersion": "string",
- "resourceID": "string",
- "kind": "Bucket",
- "templateMetaName": "string",
- "associations": [
- {
- "kind": "Bucket",
- "metaName": "string"
}
], - "links": {
- "self": "string"
}
}
], - "urls": [
- "string"
], - "updatedAt": "2019-08-24T14:15:22Z"
}
]
}| stack_id required | string The identifier of the stack. |
{- "id": "string",
- "orgID": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "events": [
- {
- "eventType": "string",
- "name": "string",
- "description": "string",
- "sources": [
- "string"
], - "resources": [
- {
- "apiVersion": "string",
- "resourceID": "string",
- "kind": "Bucket",
- "templateMetaName": "string",
- "associations": [
- {
- "kind": "Bucket",
- "metaName": "string"
}
], - "links": {
- "self": "string"
}
}
], - "urls": [
- "string"
], - "updatedAt": "2019-08-24T14:15:22Z"
}
]
}| stack_id required | string The identifier of the stack. |
The stack to update.
| name | string Nullable |
| description | string Nullable |
| templateURLs | Array of strings Nullable |
Array of objects |
{- "name": "string",
- "description": "string",
- "templateURLs": [
- "string"
], - "additionalResources": [
- {
- "resourceID": "string",
- "kind": "string",
- "templateMetaName": "string"
}
]
}{- "id": "string",
- "orgID": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "events": [
- {
- "eventType": "string",
- "name": "string",
- "description": "string",
- "sources": [
- "string"
], - "resources": [
- {
- "apiVersion": "string",
- "resourceID": "string",
- "kind": "Bucket",
- "templateMetaName": "string",
- "associations": [
- {
- "kind": "Bucket",
- "metaName": "string"
}
], - "links": {
- "self": "string"
}
}
], - "urls": [
- "string"
], - "updatedAt": "2019-08-24T14:15:22Z"
}
]
}| stack_id required | string The identifier of the stack. |
| orgID required | string The identifier of the organization. |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| stack_id required | string The identifier of the stack. |
{- "id": "string",
- "orgID": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "events": [
- {
- "eventType": "string",
- "name": "string",
- "description": "string",
- "sources": [
- "string"
], - "resources": [
- {
- "apiVersion": "string",
- "resourceID": "string",
- "kind": "Bucket",
- "templateMetaName": "string",
- "associations": [
- {
- "kind": "Bucket",
- "metaName": "string"
}
], - "links": {
- "self": "string"
}
}
], - "urls": [
- "string"
], - "updatedAt": "2019-08-24T14:15:22Z"
}
]
}Applies or performs a dry-run of template in an organization.
| dryRun | boolean |
| orgID | string |
| stackID | string |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
Array of objects or objects |
{- "dryRun": true,
- "orgID": "string",
- "stackID": "string",
- "template": {
- "contentType": "string",
- "sources": [
- "string"
], - "contents": [
- {
- "apiVersion": "string",
- "kind": "Bucket",
- "meta": {
- "name": "string"
}, - "spec": { }
}
]
}, - "templates": [
- {
- "contentType": "string",
- "sources": [
- "string"
], - "contents": [
- {
- "apiVersion": "string",
- "kind": "Bucket",
- "meta": {
- "name": "string"
}, - "spec": { }
}
]
}
], - "envRefs": {
- "property1": "string",
- "property2": "string"
}, - "secrets": {
- "property1": "string",
- "property2": "string"
}, - "remotes": [
- {
- "url": "string",
- "contentType": "string"
}
], - "actions": [
- {
- "action": "skipKind",
- "properties": {
- "kind": "Bucket"
}
}
]
}{- "sources": [
- "string"
], - "stackID": "string",
- "summary": {
- "buckets": [
- {
- "id": "string",
- "orgID": "string",
- "kind": "Bucket",
- "templateMetaName": "string",
- "name": "string",
- "description": "string",
- "retentionPeriod": 0,
- "labelAssociations": [
- {
- "id": "string",
- "orgID": "string",
- "kind": "Bucket",
- "templateMetaName": "string",
- "name": "string",
- "properties": {
- "color": "string",
- "description": "string"
}, - "envReferences": [
- {
- "resourceField": "string",
- "envRefKey": "string",
- "value": "string",
- "defaultValue": "string"
}
]
}
], - "envReferences": [
- {
- "resourceField": "string",
- "envRefKey": "string",
- "value": "string",
- "defaultValue": "string"
}
]
}
], - "checks": [
- {
- "id": "string",
- "name": "string",
- "orgID": "string",
- "taskID": "string",
- "ownerID": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "query": {
- "text": "string",
- "editMode": "builder",
- "name": "string",
- "builderConfig": {
- "buckets": [
- "string"
], - "tags": [
- {
- "key": "string",
- "values": [
- "string"
], - "aggregateFunctionType": "filter"
}
], - "functions": [
- {
- "name": "string"
}
], - "aggregateWindow": {
- "period": "string",
- "fillValues": true
}
}
}, - "status": "active",
- "description": "string",
- "latestCompleted": "2019-08-24T14:15:22Z",
- "lastRunStatus": "failed",
- "lastRunError": "string",
- "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
], - "links": {
- "self": "/api/v2/checks/1",
- "labels": "/api/v2/checks/1/labels",
- "members": "/api/v2/checks/1/members",
- "owners": "/api/v2/checks/1/owners",
- "query": "/api/v2/checks/1/query"
}, - "type": "deadman",
- "timeSince": "string",
- "staleTime": "string",
- "reportZero": true,
- "level": "UNKNOWN",
- "every": "string",
- "offset": "string",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "statusMessageTemplate": "string",
- "kind": "Bucket",
- "templateMetaName": "string",
- "labelAssociations": [
- {
- "id": "string",
- "orgID": "string",
- "kind": "Bucket",
- "templateMetaName": "string",
- "name": "string",
- "properties": {
- "color": "string",
- "description": "string"
}, - "envReferences": [
- {
- "resourceField": "string",
- "envRefKey": "string",
- "value": "string",
- "defaultValue": "string"
}
]
}
], - "envReferences": [
- {
- "resourceField": "string",
- "envRefKey": "string",
- "value": "string",
- "defaultValue": "string"
}
]
}
], - "dashboards": [
- {
- "id": "string",
- "orgID": "string",
- "kind": "Bucket",
- "templateMetaName": "string",
- "name": "string",
- "description": "string",
- "labelAssociations": [
- {
- "id": "string",
- "orgID": "string",
- "kind": "Bucket",
- "templateMetaName": "string",
- "name": "string",
- "properties": {
- "color": "string",
- "description": "string"
}, - "envReferences": [
- {
- "resourceField": "string",
- "envRefKey": "string",
- "value": "string",
- "defaultValue": "string"
}
]
}
], - "charts": [
- {
- "xPos": 0,
- "yPos": 0,
- "height": 0,
- "width": 0,
- "properties": {
- "timeFormat": "string",
- "type": "line-plus-single-stat",
- "queries": [
- {
- "text": "string",
- "editMode": "builder",
- "name": "string",
- "builderConfig": {
- "buckets": [
- "string"
], - "tags": [
- {
- "key": "string",
- "values": [
- "string"
], - "aggregateFunctionType": "filter"
}
], - "functions": [
- {
- "name": "string"
}
], - "aggregateWindow": {
- "period": "string",
- "fillValues": true
}
}
}
], - "colors": [
- {
- "id": "string",
- "type": "min",
- "hex": "strings",
- "name": "string",
- "value": 0
}
], - "shape": "chronograf-v2",
- "note": "string",
- "showNoteWhenEmpty": true,
- "axes": {
- "x": {
- "bounds": [
- "string"
], - "label": "string",
- "prefix": "string",
- "suffix": "string",
- "base": "",
- "scale": "log"
}, - "y": {
- "bounds": [
- "string"
], - "label": "string",
- "prefix": "string",
- "suffix": "string",
- "base": "",
- "scale": "log"
}
}, - "staticLegend": {
- "colorizeRows": true,
- "heightRatio": 0,
- "show": true,
- "opacity": 0,
- "orientationThreshold": 0,
- "valueAxis": "string",
- "widthRatio": 0
}, - "xColumn": "string",
- "generateXAxisTicks": [
- "string"
], - "xTotalTicks": 0,
- "xTickStart": 0,
- "xTickStep": 0,
- "yColumn": "string",
- "generateYAxisTicks": [
- "string"
], - "yTotalTicks": 0,
- "yTickStart": 0,
- "yTickStep": 0,
- "shadeBelow": true,
- "hoverDimension": "auto",
- "position": "overlaid",
- "prefix": "string",
- "suffix": "string",
- "decimalPlaces": {
- "isEnforced": true,
- "digits": 0
}, - "legendColorizeRows": true,
- "legendHide": true,
- "legendOpacity": 0,
- "legendOrientationThreshold": 0
}
}
], - "envReferences": [
- {
- "resourceField": "string",
- "envRefKey": "string",
- "value": "string",
- "defaultValue": "string"
}
]
}
], - "labels": [
- {
- "id": "string",
- "orgID": "string",
- "kind": "Bucket",
- "templateMetaName": "string",
- "name": "string",
- "properties": {
- "color": "string",
- "description": "string"
}, - "envReferences": [
- {
- "resourceField": "string",
- "envRefKey": "string",
- "value": "string",
- "defaultValue": "string"
}
]
}
], - "labelMappings": [
- {
- "status": "string",
- "resourceTemplateMetaName": "string",
- "resourceName": "string",
- "resourceID": "string",
- "resourceType": "string",
- "labelTemplateMetaName": "string",
- "labelName": "string",
- "labelID": "string"
}
], - "missingEnvRefs": [
- "string"
], - "missingSecrets": [
- "string"
], - "notificationEndpoints": [
- {
- "id": "string",
- "orgID": "string",
- "userID": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "description": "string",
- "name": "string",
- "status": "active",
- "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
], - "links": {
- "self": "/api/v2/notificationEndpoints/1",
- "labels": "/api/v2/notificationEndpoints/1/labels",
- "members": "/api/v2/notificationEndpoints/1/members",
- "owners": "/api/v2/notificationEndpoints/1/owners"
}, - "type": "slack",
- "url": "string",
- "token": "string",
- "kind": "Bucket",
- "templateMetaName": "string",
- "labelAssociations": [
- {
- "id": "string",
- "orgID": "string",
- "kind": "Bucket",
- "templateMetaName": "string",
- "name": "string",
- "properties": {
- "color": "string",
- "description": "string"
}, - "envReferences": [
- {
- "resourceField": "string",
- "envRefKey": "string",
- "value": "string",
- "defaultValue": "string"
}
]
}
], - "envReferences": [
- {
- "resourceField": "string",
- "envRefKey": "string",
- "value": "string",
- "defaultValue": "string"
}
]
}
], - "notificationRules": [
- {
- "kind": "Bucket",
- "templateMetaName": "string",
- "name": "string",
- "description": "string",
- "endpointTemplateMetaName": "string",
- "endpointID": "string",
- "endpointType": "string",
- "every": "string",
- "offset": "string",
- "messageTemplate": "string",
- "status": "string",
- "statusRules": [
- {
- "currentLevel": "string",
- "previousLevel": "string"
}
], - "tagRules": [
- {
- "key": "string",
- "value": "string",
- "operator": "string"
}
], - "labelAssociations": [
- {
- "id": "string",
- "orgID": "string",
- "kind": "Bucket",
- "templateMetaName": "string",
- "name": "string",
- "properties": {
- "color": "string",
- "description": "string"
}, - "envReferences": [
- {
- "resourceField": "string",
- "envRefKey": "string",
- "value": "string",
- "defaultValue": "string"
}
]
}
], - "envReferences": [
- {
- "resourceField": "string",
- "envRefKey": "string",
- "value": "string",
- "defaultValue": "string"
}
]
}
], - "tasks": [
- {
- "kind": "Bucket",
- "templateMetaName": "string",
- "id": "string",
- "name": "string",
- "cron": "string",
- "description": "string",
- "every": "string",
- "offset": "string",
- "query": "string",
- "status": "string",
- "envReferences": [
- {
- "resourceField": "string",
- "envRefKey": "string",
- "value": "string",
- "defaultValue": "string"
}
]
}
], - "telegrafConfigs": [
- {
- "name": "string",
- "description": "string",
- "metadata": {
- "buckets": [
- "string"
]
}, - "config": "string",
- "orgID": "string",
- "kind": "Bucket",
- "templateMetaName": "string",
- "labelAssociations": [
- {
- "id": "string",
- "orgID": "string",
- "kind": "Bucket",
- "templateMetaName": "string",
- "name": "string",
- "properties": {
- "color": "string",
- "description": "string"
}, - "envReferences": [
- {
- "resourceField": "string",
- "envRefKey": "string",
- "value": "string",
- "defaultValue": "string"
}
]
}
], - "envReferences": [
- {
- "resourceField": "string",
- "envRefKey": "string",
- "value": "string",
- "defaultValue": "string"
}
]
}
], - "variables": [
- {
- "kind": "Bucket",
- "templateMetaName": "string",
- "id": "string",
- "orgID": "string",
- "name": "string",
- "description": "string",
- "arguments": {
- "type": "query",
- "values": {
- "query": "string",
- "language": "string"
}
}, - "labelAssociations": [
- {
- "id": "string",
- "orgID": "string",
- "kind": "Bucket",
- "templateMetaName": "string",
- "name": "string",
- "properties": {
- "color": "string",
- "description": "string"
}, - "envReferences": [
- {
- "resourceField": "string",
- "envRefKey": "string",
- "value": "string",
- "defaultValue": "string"
}
]
}
], - "envReferences": [
- {
- "resourceField": "string",
- "envRefKey": "string",
- "value": "string",
- "defaultValue": "string"
}
]
}
]
}, - "diff": {
- "buckets": [
- {
- "kind": "Bucket",
- "stateStatus": "string",
- "id": "string",
- "templateMetaName": "string",
- "new": {
- "name": "string",
- "description": "string",
- "retentionRules": [
- {
- "type": "expire",
- "everySeconds": 86400,
- "shardGroupDurationSeconds": 0
}
]
}, - "old": {
- "name": "string",
- "description": "string",
- "retentionRules": [
- {
- "type": "expire",
- "everySeconds": 86400,
- "shardGroupDurationSeconds": 0
}
]
}
}
], - "checks": [
- {
- "kind": "Bucket",
- "stateStatus": "string",
- "id": "string",
- "templateMetaName": "string",
- "new": {
- "id": "string",
- "name": "string",
- "orgID": "string",
- "taskID": "string",
- "ownerID": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "query": {
- "text": "string",
- "editMode": "builder",
- "name": "string",
- "builderConfig": {
- "buckets": [
- "string"
], - "tags": [
- {
- "key": "string",
- "values": [
- "string"
], - "aggregateFunctionType": "filter"
}
], - "functions": [
- {
- "name": "string"
}
], - "aggregateWindow": {
- "period": "string",
- "fillValues": true
}
}
}, - "status": "active",
- "description": "string",
- "latestCompleted": "2019-08-24T14:15:22Z",
- "lastRunStatus": "failed",
- "lastRunError": "string",
- "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
], - "links": {
- "self": "/api/v2/checks/1",
- "labels": "/api/v2/checks/1/labels",
- "members": "/api/v2/checks/1/members",
- "owners": "/api/v2/checks/1/owners",
- "query": "/api/v2/checks/1/query"
}, - "type": "deadman",
- "timeSince": "string",
- "staleTime": "string",
- "reportZero": true,
- "level": "UNKNOWN",
- "every": "string",
- "offset": "string",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "statusMessageTemplate": "string"
}, - "old": {
- "id": "string",
- "name": "string",
- "orgID": "string",
- "taskID": "string",
- "ownerID": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "query": {
- "text": "string",
- "editMode": "builder",
- "name": "string",
- "builderConfig": {
- "buckets": [
- "string"
], - "tags": [
- {
- "key": "string",
- "values": [
- "string"
], - "aggregateFunctionType": "filter"
}
], - "functions": [
- {
- "name": "string"
}
], - "aggregateWindow": {
- "period": "string",
- "fillValues": true
}
}
}, - "status": "active",
- "description": "string",
- "latestCompleted": "2019-08-24T14:15:22Z",
- "lastRunStatus": "failed",
- "lastRunError": "string",
- "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
], - "links": {
- "self": "/api/v2/checks/1",
- "labels": "/api/v2/checks/1/labels",
- "members": "/api/v2/checks/1/members",
- "owners": "/api/v2/checks/1/owners",
- "query": "/api/v2/checks/1/query"
}, - "type": "deadman",
- "timeSince": "string",
- "staleTime": "string",
- "reportZero": true,
- "level": "UNKNOWN",
- "every": "string",
- "offset": "string",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "statusMessageTemplate": "string"
}
}
], - "dashboards": [
- {
- "stateStatus": "string",
- "id": "string",
- "kind": "Bucket",
- "templateMetaName": "string",
- "new": {
- "name": "string",
- "description": "string",
- "charts": [
- {
- "xPos": 0,
- "yPos": 0,
- "height": 0,
- "width": 0,
- "properties": {
- "timeFormat": "string",
- "type": "line-plus-single-stat",
- "queries": [
- {
- "text": "string",
- "editMode": "builder",
- "name": "string",
- "builderConfig": {
- "buckets": [
- "string"
], - "tags": [
- {
- "key": "string",
- "values": [
- "string"
], - "aggregateFunctionType": "filter"
}
], - "functions": [
- {
- "name": "string"
}
], - "aggregateWindow": {
- "period": "string",
- "fillValues": true
}
}
}
], - "colors": [
- {
- "id": "string",
- "type": "min",
- "hex": "strings",
- "name": "string",
- "value": 0
}
], - "shape": "chronograf-v2",
- "note": "string",
- "showNoteWhenEmpty": true,
- "axes": {
- "x": {
- "bounds": [
- "string"
], - "label": "string",
- "prefix": "string",
- "suffix": "string",
- "base": "",
- "scale": "log"
}, - "y": {
- "bounds": [
- "string"
], - "label": "string",
- "prefix": "string",
- "suffix": "string",
- "base": "",
- "scale": "log"
}
}, - "staticLegend": {
- "colorizeRows": true,
- "heightRatio": 0,
- "show": true,
- "opacity": 0,
- "orientationThreshold": 0,
- "valueAxis": "string",
- "widthRatio": 0
}, - "xColumn": "string",
- "generateXAxisTicks": [
- "string"
], - "xTotalTicks": 0,
- "xTickStart": 0,
- "xTickStep": 0,
- "yColumn": "string",
- "generateYAxisTicks": [
- "string"
], - "yTotalTicks": 0,
- "yTickStart": 0,
- "yTickStep": 0,
- "shadeBelow": true,
- "hoverDimension": "auto",
- "position": "overlaid",
- "prefix": "string",
- "suffix": "string",
- "decimalPlaces": {
- "isEnforced": true,
- "digits": 0
}, - "legendColorizeRows": true,
- "legendHide": true,
- "legendOpacity": 0,
- "legendOrientationThreshold": 0
}
}
]
}, - "old": {
- "name": "string",
- "description": "string",
- "charts": [
- {
- "xPos": 0,
- "yPos": 0,
- "height": 0,
- "width": 0,
- "properties": {
- "timeFormat": "string",
- "type": "line-plus-single-stat",
- "queries": [
- {
- "text": "string",
- "editMode": "builder",
- "name": "string",
- "builderConfig": {
- "buckets": [
- "string"
], - "tags": [
- {
- "key": "string",
- "values": [
- "string"
], - "aggregateFunctionType": "filter"
}
], - "functions": [
- {
- "name": "string"
}
], - "aggregateWindow": {
- "period": "string",
- "fillValues": true
}
}
}
], - "colors": [
- {
- "id": "string",
- "type": "min",
- "hex": "strings",
- "name": "string",
- "value": 0
}
], - "shape": "chronograf-v2",
- "note": "string",
- "showNoteWhenEmpty": true,
- "axes": {
- "x": {
- "bounds": [
- "string"
], - "label": "string",
- "prefix": "string",
- "suffix": "string",
- "base": "",
- "scale": "log"
}, - "y": {
- "bounds": [
- "string"
], - "label": "string",
- "prefix": "string",
- "suffix": "string",
- "base": "",
- "scale": "log"
}
}, - "staticLegend": {
- "colorizeRows": true,
- "heightRatio": 0,
- "show": true,
- "opacity": 0,
- "orientationThreshold": 0,
- "valueAxis": "string",
- "widthRatio": 0
}, - "xColumn": "string",
- "generateXAxisTicks": [
- "string"
], - "xTotalTicks": 0,
- "xTickStart": 0,
- "xTickStep": 0,
- "yColumn": "string",
- "generateYAxisTicks": [
- "string"
], - "yTotalTicks": 0,
- "yTickStart": 0,
- "yTickStep": 0,
- "shadeBelow": true,
- "hoverDimension": "auto",
- "position": "overlaid",
- "prefix": "string",
- "suffix": "string",
- "decimalPlaces": {
- "isEnforced": true,
- "digits": 0
}, - "legendColorizeRows": true,
- "legendHide": true,
- "legendOpacity": 0,
- "legendOrientationThreshold": 0
}
}
]
}
}
], - "labels": [
- {
- "stateStatus": "string",
- "kind": "Bucket",
- "id": "string",
- "templateMetaName": "string",
- "new": {
- "name": "string",
- "color": "string",
- "description": "string"
}, - "old": {
- "name": "string",
- "color": "string",
- "description": "string"
}
}
], - "labelMappings": [
- {
- "status": "string",
- "resourceType": "string",
- "resourceID": "string",
- "resourceTemplateMetaName": "string",
- "resourceName": "string",
- "labelID": "string",
- "labelTemplateMetaName": "string",
- "labelName": "string"
}
], - "notificationEndpoints": [
- {
- "kind": "Bucket",
- "stateStatus": "string",
- "id": "string",
- "templateMetaName": "string",
- "new": {
- "id": "string",
- "orgID": "string",
- "userID": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "description": "string",
- "name": "string",
- "status": "active",
- "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
], - "links": {
- "self": "/api/v2/notificationEndpoints/1",
- "labels": "/api/v2/notificationEndpoints/1/labels",
- "members": "/api/v2/notificationEndpoints/1/members",
- "owners": "/api/v2/notificationEndpoints/1/owners"
}, - "type": "slack",
- "url": "string",
- "token": "string"
}, - "old": {
- "id": "string",
- "orgID": "string",
- "userID": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "description": "string",
- "name": "string",
- "status": "active",
- "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
], - "links": {
- "self": "/api/v2/notificationEndpoints/1",
- "labels": "/api/v2/notificationEndpoints/1/labels",
- "members": "/api/v2/notificationEndpoints/1/members",
- "owners": "/api/v2/notificationEndpoints/1/owners"
}, - "type": "slack",
- "url": "string",
- "token": "string"
}
}
], - "notificationRules": [
- {
- "kind": "Bucket",
- "stateStatus": "string",
- "id": "string",
- "templateMetaName": "string",
- "new": {
- "name": "string",
- "description": "string",
- "endpointName": "string",
- "endpointID": "string",
- "endpointType": "string",
- "every": "string",
- "offset": "string",
- "messageTemplate": "string",
- "status": "string",
- "statusRules": [
- {
- "currentLevel": "string",
- "previousLevel": "string"
}
], - "tagRules": [
- {
- "key": "string",
- "value": "string",
- "operator": "string"
}
]
}, - "old": {
- "name": "string",
- "description": "string",
- "endpointName": "string",
- "endpointID": "string",
- "endpointType": "string",
- "every": "string",
- "offset": "string",
- "messageTemplate": "string",
- "status": "string",
- "statusRules": [
- {
- "currentLevel": "string",
- "previousLevel": "string"
}
], - "tagRules": [
- {
- "key": "string",
- "value": "string",
- "operator": "string"
}
]
}
}
], - "tasks": [
- {
- "kind": "Bucket",
- "stateStatus": "string",
- "id": "string",
- "templateMetaName": "string",
- "new": {
- "name": "string",
- "cron": "string",
- "description": "string",
- "every": "string",
- "offset": "string",
- "query": "string",
- "status": "string"
}, - "old": {
- "name": "string",
- "cron": "string",
- "description": "string",
- "every": "string",
- "offset": "string",
- "query": "string",
- "status": "string"
}
}
], - "telegrafConfigs": [
- {
- "kind": "Bucket",
- "stateStatus": "string",
- "id": "string",
- "templateMetaName": "string",
- "new": {
- "name": "string",
- "description": "string",
- "metadata": {
- "buckets": [
- "string"
]
}, - "config": "string",
- "orgID": "string"
}, - "old": {
- "name": "string",
- "description": "string",
- "metadata": {
- "buckets": [
- "string"
]
}, - "config": "string",
- "orgID": "string"
}
}
], - "variables": [
- {
- "kind": "Bucket",
- "stateStatus": "string",
- "id": "string",
- "templateMetaName": "string",
- "new": {
- "name": "string",
- "description": "string",
- "args": {
- "type": "query",
- "values": {
- "query": "string",
- "language": "string"
}
}
}, - "old": {
- "name": "string",
- "description": "string",
- "args": {
- "type": "query",
- "values": {
- "query": "string",
- "language": "string"
}
}
}
}
]
}, - "errors": [
- {
- "kind": "Bucket",
- "reason": "string",
- "fields": [
- "string"
], - "indexes": [
- 0
]
}
]
}Export resources as an InfluxDB template.
| stackID | string |
Array of objects | |
Array of objects |
{- "stackID": "string",
- "orgIDs": [
- {
- "orgID": "string",
- "resourceFilters": {
- "byLabel": [
- "string"
], - "byResourceKind": [
- "Bucket"
]
}
}
], - "resources": [
- {
- "id": "string",
- "kind": "Bucket",
- "name": "string"
}
]
}[- {
- "apiVersion": "string",
- "kind": "Bucket",
- "meta": {
- "name": "string"
}, - "spec": { }
}
]| orgID required | string The identifier of the organization. |
| start required | timestamp start time |
| stop | timestamp stop time |
| raw | boolean Default: false return raw usage data |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "id": "string",
- "oauthID": "string",
- "name": "string",
- "status": "active",
- "links": {
- "self": "/api/v2/users/1"
}
}| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
New password
| password required | string |
{- "password": "string"
}{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| userID required | string The user ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
New password
| password required | string |
{- "password": "string"
}{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "users": [
- {
- "id": "string",
- "oauthID": "string",
- "name": "string",
- "status": "active",
- "links": {
- "self": "/api/v2/users/1"
}
}
]
}| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
User to create
| oauthID | string |
| name required | string |
| status | string Default: "active" Enum: "active" "inactive" If inactive the user is inactive. |
| role | string Enum: "owner" "member" |
| org_id | string |
{- "oauthID": "string",
- "name": "string",
- "status": "active",
- "role": "owner",
- "org_id": "string"
}{- "id": "string",
- "oauthID": "string",
- "name": "string",
- "status": "active",
- "links": {
- "self": "/api/v2/users/1"
}
}| userID required | string The user ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "id": "string",
- "oauthID": "string",
- "name": "string",
- "status": "active",
- "links": {
- "self": "/api/v2/users/1"
}
}| userID required | string The ID of the user to update. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
User update to apply
| oauthID | string |
| name required | string |
| status | string Default: "active" Enum: "active" "inactive" If inactive the user is inactive. |
| role | string Enum: "owner" "member" |
| org_id | string |
{- "oauthID": "string",
- "name": "string",
- "status": "active",
- "role": "owner",
- "org_id": "string"
}{- "id": "string",
- "oauthID": "string",
- "name": "string",
- "status": "active",
- "links": {
- "self": "/api/v2/users/1"
}
}| userID required | string The ID of the user to delete. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| variableID required | string The variable ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
],
}| variableID required | string The variable ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Label to add
| labelID | string |
{- "labelID": "string"
}{- "label": {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
},
}| variableID required | string The variable ID. |
| labelID required | string The label ID to delete. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| org | string The name of the organization. |
| orgID | string The organization ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "variables": [
- {
- "id": "1221432",
- "name": ":ok:",
- "selected": [
- "hello"
], - "arguments": {
- "type": "constant",
- "values": [
- "howdy",
- "hello",
- "hi",
- "yo",
- "oy"
]
}
}, - {
- "id": "1221432",
- "name": ":ok:",
- "selected": [
- "c"
], - "arguments": {
- "type": "map",
- "values": {
- "a": "fdjaklfdjkldsfjlkjdsa",
- "b": "dfaksjfkljekfajekdljfas",
- "c": "fdjksajfdkfeawfeea"
}
}
}, - {
- "id": "1221432",
- "name": ":ok:",
- "selected": [
- "host"
], - "arguments": {
- "type": "query",
- "query": "from(bucket: \"foo\") |> showMeasurements()",
- "language": "flux"
}
}
]
}| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Variable to create
| orgID required | string |
| name required | string |
| description | string |
| selected | Array of strings |
| sort_order | integer |
Array of objects (Labels) | |
required | QueryVariableProperties (object) or ConstantVariableProperties (object) or MapVariableProperties (object) (VariableProperties) |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "orgID": "string",
- "name": "string",
- "description": "string",
- "selected": [
- "string"
], - "sort_order": 0,
- "labels": [
- {
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
], - "arguments": {
- "type": "query",
- "values": {
- "query": "string",
- "language": "string"
}
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "id": "string",
- "orgID": "string",
- "name": "string",
- "description": "string",
- "selected": [
- "string"
], - "sort_order": 0,
- "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
], - "arguments": {
- "type": "query",
- "values": {
- "query": "string",
- "language": "string"
}
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| variableID required | string The variable ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "id": "string",
- "orgID": "string",
- "name": "string",
- "description": "string",
- "selected": [
- "string"
], - "sort_order": 0,
- "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
], - "arguments": {
- "type": "query",
- "values": {
- "query": "string",
- "language": "string"
}
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| variableID required | string The variable ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string"
}| variableID required | string The variable ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Variable update to apply
| orgID required | string |
| name required | string |
| description | string |
| selected | Array of strings |
| sort_order | integer |
Array of objects (Labels) | |
required | QueryVariableProperties (object) or ConstantVariableProperties (object) or MapVariableProperties (object) (VariableProperties) |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "orgID": "string",
- "name": "string",
- "description": "string",
- "selected": [
- "string"
], - "sort_order": 0,
- "labels": [
- {
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
], - "arguments": {
- "type": "query",
- "values": {
- "query": "string",
- "language": "string"
}
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "id": "string",
- "orgID": "string",
- "name": "string",
- "description": "string",
- "selected": [
- "string"
], - "sort_order": 0,
- "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
], - "arguments": {
- "type": "query",
- "values": {
- "query": "string",
- "language": "string"
}
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| variableID required | string The variable ID. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
Variable to replace
| orgID required | string |
| name required | string |
| description | string |
| selected | Array of strings |
| sort_order | integer |
Array of objects (Labels) | |
required | QueryVariableProperties (object) or ConstantVariableProperties (object) or MapVariableProperties (object) (VariableProperties) |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "orgID": "string",
- "name": "string",
- "description": "string",
- "selected": [
- "string"
], - "sort_order": 0,
- "labels": [
- {
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
], - "arguments": {
- "type": "query",
- "values": {
- "query": "string",
- "language": "string"
}
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "id": "string",
- "orgID": "string",
- "name": "string",
- "description": "string",
- "selected": [
- "string"
], - "sort_order": 0,
- "labels": [
- {
- "id": "string",
- "orgID": "string",
- "name": "string",
- "properties": {
- "color": "ffb3b3",
- "description": "this is a description"
}
}
], - "arguments": {
- "type": "query",
- "values": {
- "query": "string",
- "language": "string"
}
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}Writes data to a bucket.
To write data into InfluxDB, you need the following:
For more information and examples, see Write data with the InfluxDB API.
| org required | string The parameter value specifies the destination organization for writes. The database writes all points in the batch to this organization. If you provide both |
| orgID | string The parameter value specifies the ID of the destination organization for writes. If both |
| bucket required | string The destination bucket for writes. |
| precision | string (WritePrecision) Enum: "ms" "s" "us" "ns" The precision for the unix timestamps within the body line-protocol. |
| Zap-Trace-Span | string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context |
| Content-Encoding | string Default: identity Enum: "gzip" "identity" When present, the header value tells the database that compression is applied to the line protocol in the request body. |
| Content-Type | string Default: text/plain; charset=utf-8 Enum: "text/plain" "text/plain; charset=utf-8" "application/vnd.influx.arrow" The header value indicates the format of the data in the request body. |
| Content-Length | integer The header value indicates the size of the entity-body, in bytes, sent to the database. If the length is greater than the database's |
| Accept | string Default: application/json Value: "application/json" The header value specifies the response format. |
Data in line protocol format.
{- "code": "internal error",
- "message": "string",
- "op": "string",
- "err": "string",
- "line": 0
}